<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*
* @package CiviCRM_APIv3_Core
* @subpackage API_Settings
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* @version $Id: Settings.php
*
*/
CRM_Utils_Array::value('profile', $params, null)
);
// find any supplemental information
- if(CRM_Utils_Array::value('action',$params)){
- $specFunction = 'civicrm_api3_setting_' . $params['action'] . '_spec';
+ if (!empty($params['action'])){
+ $specFunction = '_civicrm_api3_setting_' . strtolower($params['action']) . '_spec';
if (function_exists($specFunction)) {
$specFunction($result);
}
}
return civicrm_api3_create_success($result, $params, 'setting', 'getfields');
}
-/*
+
+/**
* Alter metadata for getfields functions
*/
-function civicrm_api3_setting_getfields_spec(&$params) {
+function _civicrm_api3_setting_getfields_spec(&$params) {
$params['filters'] = array('title' => 'Fields you wish to filter by e.g. array("group_name" => "CiviCRM Preferences")');
$params['component_id'] = array('title' => 'id of relevant component');
$params['profile'] = array('title' => 'profile is passed through to hooks & added to cachestring');
}
-/*
+
+/**
* Return default values for settings. 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
*/
function civicrm_api3_setting_getdefaults(&$params){
- $settings = civicrm_api('setting','getfields', $params);
+ $settings = civicrm_api3('setting','getfields', $params);
$domains = _civicrm_api3_setting_getDomainArray($params);
$defaults = array();
foreach ($domains as $domainID){
}
return civicrm_api3_create_success($defaults,$params,'setting','getfields');
}
-/*
-* Metadata for setting create function
-*
-* @param array $params parameters as passed to the API
-*/
-function civicrm_api3_setting_getdefaults_spec(&$params) {
+/**
+ * Metadata for setting create function
+ *
+ * @param array $params parameters as passed to the API
+ */
+function _civicrm_api3_setting_getdefaults_spec(&$params) {
$params['domain_id'] = array(
'api.default' => 'current_domain',
'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the current domain
an array or "all" are acceptable values for multiple domains'
);
}
-/*
+
+/**
* Revert settings to defaults
*/
function civicrm_api3_setting_revert(&$params){
return civicrm_api3_create_success($result, $params, 'setting', 'revert');
}
-/*
+
+/**
* Alter metadata for getfields functions
-*/
-function civicrm_api3_setting_revert_spec(&$params) {
+ */
+function _civicrm_api3_setting_revert_spec(&$params) {
$params['name'] = array('title' => 'Setting Name belongs to');
$params['component_id'] = array('title' => 'id of relevant component');
$params['domain_id'] = array(
);
}
-/*
+/**
* Revert settings to defaults
-*/
+ */
function civicrm_api3_setting_fill(&$params){
- $defaults = civicrm_api('setting','getdefaults', $params);
+ $defaults = civicrm_api3('setting','getdefaults', $params);
$domains = _civicrm_api3_setting_getDomainArray($params);
$result = array();
foreach ($domains as $domainID){
'version' => $params['version'],
'domain_id' => $domainID
);
- $existing = civicrm_api('setting','get', $apiArray);
+ $existing = civicrm_api3('setting','get', $apiArray);
$valuesToFill = array_diff_key($defaults['values'][$domainID], $existing['values'][$domainID]);
if(!empty($valuesToFill)){
$result = array_merge($result, civicrm_api('setting', 'create', $valuesToFill + $apiArray));
}
return civicrm_api3_create_success($result, $params, 'setting', 'fill');
}
-/*
+
+/**
* Alter metadata for getfields functions
-*/
-function civicrm_api3_setting_fill_spec(&$params) {
+ */
+function _civicrm_api3_setting_fill_spec(&$params) {
$params['name'] = array('title' => 'Setting Name belongs to');
$params['component_id'] = array('title' => 'id of relevant component');
$params['domain_id'] = array(
$result = CRM_Core_BAO_Setting::setItems($params, $domains);
return civicrm_api3_create_success($result,$params,'setting','create');
}
-/*
+
+/**
* Metadata for setting create function
*
* @param array $params parameters as passed to the API
*/
-function civicrm_api3_setting_create_spec(&$params) {
+function _civicrm_api3_setting_create_spec(&$params) {
$params['domain_id'] = array(
'api.default' => 'current_domain',
'description' => 'if you do not pass in a domain id this will default to the current domain
$result = $result = CRM_Core_BAO_Setting::getItems($params, $domains, CRM_Utils_Array::value('return', $params, array()));
return civicrm_api3_create_success($result,$params,'setting','get');
}
-/*
+/**
* Metadata for setting create function
-*
-* @param array $params parameters as passed to the API
-*/
-function civicrm_api3_setting_get_spec(&$params) {
+ *
+ * @param array $params parameters as passed to the API
+ */
+function _civicrm_api3_setting_get_spec(&$params) {
$params['domain_id'] = array(
'api.default' => 'current_domain',
'description' => 'if you do not pass in a domain id this will default to the current domain'
);
}
-/*
+/**
* Metadata for setting create function
-*
-* @param array $params parameters as passed to the API
-*/
-function civicrm_api3_setting_getvalue_spec(&$params) {
+ *
+ * @param array $params parameters as passed to the API
+ */
+function _civicrm_api3_setting_getvalue_spec(&$params) {
$params['group'] = array(
'title' => 'Settings Group',
'description' => 'if you do not pass in a domain id this will default to the current domain'
);
}
-/*
+
+/**
* Converts domain input into an array. 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
*/
function _civicrm_api3_setting_getDomainArray(&$params){
+ if(empty($params['domain_id']) && isset($params['id'])){
+ $params['domain_id'] = $params['id'];
+ }
+
if($params['domain_id'] == 'current_domain'){
$params['domain_id'] = CRM_Core_Config::domainID();
}