X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FSetting.php;h=45ecdf2ff5d5df55a572db73d3ccbb166075521a;hb=4df9546fb69f4040536b02d5df14b4c975e423c2;hp=4ac880c6251b2b977103716991d664c0c26259cd;hpb=2f80514459490a0a12212d2989d3a435ba4c33de;p=civicrm-core.git diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 4ac880c625..45ecdf2ff5 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -1,9 +1,9 @@ delete($cacheKey); } + /** + * @param $values + * @param $group + * @param null $componentID + * @param null $contactID + * @param null $domainID + * + * @return string + */ static function setCache($values, $group, $componentID = NULL, @@ -136,6 +149,15 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { return $cacheKey; } + /** + * @param $group + * @param null $name + * @param null $componentID + * @param null $contactID + * @param null $domainID + * + * @return CRM_Core_DAO_Domain|CRM_Core_DAO_Setting + */ static function dao($group, $name = NULL, $componentID = NULL, @@ -176,11 +198,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Retrieve the value of a setting from the DB table * * @param string $group (required) The group name of the item - * @param string $name (required) The name under which this item is stored - * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param string $name (required) The name under which this item is stored + * @param int $componentID The optional component ID (so componenets can share the same name space) * @param string $defaultValue The default value to return for this setting if not present in DB - * @param int $contactID If set, this is a contactID specific setting, else its a global setting - + * @param int $contactID If set, this is a contactID specific setting, else its a global setting + * + * @param null $domainID * * @return object The data if present in the setting table, else null * @static @@ -230,6 +253,9 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Store multiple items in the setting table * * @param array $params (required) An api formatted array of keys and values + * @param null $domains + * @param $settingsToReturn + * * @domains array an array of domains to get settings for. Default is the current domain * @return void * @static @@ -296,9 +322,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * @param object $value (required) The value that will be serialized and stored * @param string $group (required) The group name of the item - * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so componenets can share the same name space) - * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session + * @param string $name (required) The name of the setting + * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param null $contactID + * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session + * + * @param null $domainID * * @return void * @static @@ -411,8 +440,11 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * _setItem() is the common logic shared by setItem() and setItems(). * * @param array $params (required) An api formatted array of keys and values + * @param null $domains + * + * @throws api_Exception * @domains array an array of domains to get settings for. Default is the current domain - * @return void + * @return array * @static * @access public */ @@ -475,10 +507,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * gets metadata about the settings fields (from getfields) based on the fields being passed in * * This function filters on the fields like 'version' & 'debug' that are not settings + * * @param array $params Parameters as passed into API * @param array $fields empty array to be populated with fields metadata * @param bool $createMode * + * @throws api_Exception * @return array $fieldstoset name => value array of the fields to be set (with extraneous removed) */ static function validateSettingsInput($params, &$fields, $createMode = TRUE) { @@ -509,7 +543,7 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { list($name) = array_keys($settingParams); $getFieldsParams['name'] = $name; } - $fields = civicrm_api('setting','getfields', $getFieldsParams); + $fields = civicrm_api3('setting','getfields', $getFieldsParams); $invalidParams = (array_diff_key($settingParams, $fields['values'])); if (!empty($invalidParams)) { throw new api_Exception(implode(',', $invalidParams) . " not valid settings"); @@ -610,6 +644,11 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * @params string $name Name of specific setting e.g customCSSURL * @params integer $componentID id of relevant component. * + * @param null $componentID + * @param array $filters + * @param null $domainID + * @param null $profile + * * @return array $result - the following information as appropriate for each setting * - name * - type @@ -790,6 +829,18 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } } + /** + * @param $group + * @param $name + * @param bool $system + * @param null $userID + * @param bool $localize + * @param string $returnField + * @param bool $returnNameANDLabels + * @param null $condition + * + * @return array + */ static function valueOptions($group, $name, $system = TRUE, @@ -840,6 +891,14 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { return ($returnNameANDLabels) ? $nameAndLabels : $returnValues; } + /** + * @param $group + * @param $name + * @param $value + * @param bool $system + * @param null $userID + * @param string $keyField + */ static function setValueOption($group, $name, $value, @@ -876,6 +935,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { self::setItem($optionValue, $group, $name); } + /** + * @param $params + * @param null $domainID + */ static function fixAndStoreDirAndURL(&$params, $domainID = NULL) { if (self::isUpgradeFromPreFourOneAlpha1()) { return; @@ -947,6 +1010,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } } + /** + * @param $params + * @param $group + */ static function storeDirectoryOrURLPreferences(&$params, $group) { foreach ($params as $name => $value) { // always try to store relative directory or url from CMS root @@ -956,6 +1023,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } } + /** + * @param $params + * @param bool $setInConfig + */ static function retrieveDirectoryAndURLPreferences(&$params, $setInConfig = FALSE) { if (CRM_Core_Config::isUpgradeMode()) { $isJoomla = (defined('CIVICRM_UF') && CIVICRM_UF == 'Joomla') ? TRUE : FALSE; @@ -1027,6 +1098,10 @@ AND domain_id = %3 * Determine what, if any, overrides have been provided * for a setting. * + * @param $group + * @param $name + * @param $default + * * @return mixed, NULL or an overriden value */ protected static function getOverride($group, $name, $default) {