Setting.php
This api exposes CiviCRM configuration settings.
Table of Contents
Functions
- civicrm_api3_setting_getfields() : array<string|int, mixed>
- Get fields for setting api calls.
- _civicrm_api3_setting_getfields_spec() : mixed
- Alter metadata for getfields functions.
- civicrm_api3_setting_getdefaults() : array<string|int, mixed>
- Return default values for settings.
- _civicrm_api3_setting_getdefaults_spec() : mixed
- Metadata for Setting create function.
- civicrm_api3_setting_getoptions() : array<string|int, mixed>
- Get options for settings.
- civicrm_api3_setting_revert() : array<string|int, mixed>
- Revert settings to defaults.
- _civicrm_api3_setting_revert_spec() : mixed
- Alter metadata for getfields functions.
- civicrm_api3_setting_fill() : array<string|int, mixed>
- Revert settings to defaults.
- _civicrm_api3_setting_fill_spec() : mixed
- Alter metadata for getfields functions.
- _civicrm_api3_setting_deprecation() : array<string|int, mixed>
- Declare deprecated api functions.
- civicrm_api3_setting_create() : array<string|int, mixed>
- Create or update a setting.
- _civicrm_api3_setting_create_spec() : mixed
- Metadata for setting create function.
- civicrm_api3_setting_get() : array<string|int, mixed>
- Returns array of settings matching input parameters.
- _civicrm_api3_setting_get_spec() : mixed
- Metadata for setting create function.
- civicrm_api3_setting_getvalue() : array<string|int, mixed>
- Returns value for specific parameter.
- _civicrm_api3_setting_getvalue_spec() : mixed
- Metadata for setting create function.
- _civicrm_api3_setting_getDomainArray() : array<string|int, mixed>
- Converts domain input into an array.
Functions
civicrm_api3_setting_getfields()
Get fields for setting api calls.
civicrm_api3_setting_getfields(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>_civicrm_api3_setting_getfields_spec()
Alter metadata for getfields functions.
_civicrm_api3_setting_getfields_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_setting_getdefaults()
Return default values for settings.
civicrm_api3_setting_getdefaults(array<string|int, mixed> $params) : array<string|int, mixed>
We will domain key this as it could vary by domain (ie. urls) as we will be creating the option for a function rather than an value to be in the defaults Note that is not in place as yet.
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_setting_getdefaults_spec()
Metadata for Setting create function.
_civicrm_api3_setting_getdefaults_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Parameters as passed to the API.
civicrm_api3_setting_getoptions()
Get options for settings.
civicrm_api3_setting_getoptions(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>civicrm_api3_setting_revert()
Revert settings to defaults.
civicrm_api3_setting_revert(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_setting_revert_spec()
Alter metadata for getfields functions.
_civicrm_api3_setting_revert_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
civicrm_api3_setting_fill()
Revert settings to defaults.
civicrm_api3_setting_fill(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_civicrm_api3_setting_fill_spec()
Alter metadata for getfields functions.
_civicrm_api3_setting_fill_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
_civicrm_api3_setting_deprecation()
Declare deprecated api functions.
_civicrm_api3_setting_deprecation() : array<string|int, mixed>
Return values
array<string|int, mixed>civicrm_api3_setting_create()
Create or update a setting.
civicrm_api3_setting_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Parameters as per getfields.
Tags
Return values
array<string|int, mixed> —api result array
_civicrm_api3_setting_create_spec()
Metadata for setting create function.
_civicrm_api3_setting_create_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Parameters as passed to the API.
civicrm_api3_setting_get()
Returns array of settings matching input parameters.
civicrm_api3_setting_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of one or more valid property_name=>value pairs.
Return values
array<string|int, mixed> —Array of matching settings
_civicrm_api3_setting_get_spec()
Metadata for setting create function.
_civicrm_api3_setting_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Parameters as passed to the API.
civicrm_api3_setting_getvalue()
Returns value for specific parameter.
civicrm_api3_setting_getvalue(array<string|int, mixed> $params) : array<string|int, mixed>
Function requires more fields than 'get' but is intended for runtime usage & should be quicker
Parameters
- $params : array<string|int, mixed>
-
Array of one or more valid. property_name=>value pairs.
Return values
array<string|int, mixed> —API result array.
_civicrm_api3_setting_getvalue_spec()
Metadata for setting create function.
_civicrm_api3_setting_getvalue_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Parameters as passed to the API.
_civicrm_api3_setting_getDomainArray()
Converts domain input into an array.
_civicrm_api3_setting_getDomainArray(array<string|int, mixed> &$params) : array<string|int, mixed>
If an array is passed in this is used, if 'all' is passed in this is converted to 'all arrays'
Really domain_id should always be set but doing an empty check because at the moment using crm-editable will pass an id & default won't be applied we did talk about id being a pseudonym for domain_id in this api so applying it here.
Parameters
- $params : array<string|int, mixed>