<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
require_once 'CiviTest/CiviUnitTestCase.php';
/**
* Test APIv3 civicrm_setting_* functions
*
- * @package CiviCRM_APIv3
- * @subpackage API_Core
+ * @package CiviCRM_APIv3
+ * @subpackage API_Core
*/
/**
protected $_domainID2;
protected $_domainID3;
- /**
- *
- */
- function __construct() {
- parent::__construct();
-
- }
-
- /**
- * @return array
- */
- function get_info() {
- return array(
- 'name' => 'Settings Tests',
- 'description' => 'Settings API',
- 'group' => 'CiviCRM API Tests',
- );
- }
-
- function setUp() {
+ public function setUp() {
parent::setUp();
$params = array(
'name' => 'Default Domain Name',
);
- $result = $this->callAPISuccess( 'domain','get',$params);
- if(empty($result['id'])){
- $result = $this->callAPISuccess( 'domain','create',$params );
+ $result = $this->callAPISuccess('domain', 'get', $params);
+ if (empty($result['id'])) {
+ $result = $this->callAPISuccess('domain', 'create', $params);
}
$params['name'] = 'Second Domain';
- $result = $this->callAPISuccess( 'domain','get',$params);
- if(empty($result['id'])){
- $result = $this->callAPISuccess( 'domain','create',$params );
+ $result = $this->callAPISuccess('domain', 'get', $params);
+ if (empty($result['id'])) {
+ $result = $this->callAPISuccess('domain', 'create', $params);
}
$this->_domainID2 = $result['id'];
$params['name'] = 'A-team domain';
- $result = $this->callAPISuccess( 'domain','get',$params);
- if(empty($result['id'])){
- $result = $this->callAPISuccess( 'domain','create',$params );
+ $result = $this->callAPISuccess('domain', 'get', $params);
+ if (empty($result['id'])) {
+ $result = $this->callAPISuccess('domain', 'create', $params);
}
$this->_domainID3 = $result['id'];
$this->_currentDomain = CRM_Core_Config::domainID();
$this->hookClass = CRM_Utils_Hook::singleton();
}
- function tearDown() {
+ public function tearDown() {
CRM_Utils_Hook::singleton()->reset();
parent::tearDown();
- $this->callAPISuccess('system','flush', array());
+ $this->callAPISuccess('system', 'flush', array());
$this->quickCleanup(array('civicrm_domain'));
}
* Set additional settings into metadata (implements hook)
* @param array $metaDataFolders
*/
- function setExtensionMetadata(&$metaDataFolders) {
+ public function setExtensionMetadata(&$metaDataFolders) {
global $civicrm_root;
$metaDataFolders[] = $civicrm_root . '/tests/phpunit/api/v3/settings';
}
+
/**
- /**
- * Check getfields works
+ * /**
+ * Check getfields works.
*/
- function testGetFields() {
+ public function testGetFields() {
$description = 'Demonstrate return from getfields - see subfolder for variants';
$result = $this->callAPIAndDocument('setting', 'getfields', array(), __FUNCTION__, __FILE__, $description);
$this->assertArrayHasKey('customCSSURL', $result['values']);
$description = 'Demonstrate return from getfields';
$result = $this->callAPISuccess('setting', 'getfields', array());
$this->assertArrayHasKey('customCSSURL', $result['values']);
- $this->callAPISuccess('system','flush', array());
+ $this->callAPISuccess('system', 'flush', array());
}
/**
* Let's check it's loading from cache by meddling with the cache
*/
- function testGetFieldsCaching() {
+ public function testGetFieldsCaching() {
$settingsMetadata = array();
- CRM_Core_BAO_Cache::setItem($settingsMetadata,'CiviCRM setting Specs', 'settingsMetadata__');
- CRM_Core_BAO_Cache::setItem($settingsMetadata,'CiviCRM setting Spec', 'All');
+ CRM_Core_BAO_Cache::setItem($settingsMetadata, 'CiviCRM setting Specs', 'settingsMetadata__');
+ CRM_Core_BAO_Cache::setItem($settingsMetadata, 'CiviCRM setting Spec', 'All');
$result = $this->callAPISuccess('setting', 'getfields', array());
$this->assertArrayNotHasKey('customCSSURL', $result['values']);
$this->quickCleanup(array('civicrm_cache'));
}
- function testGetFieldsFilters() {
+ public function testGetFieldsFilters() {
$params = array('name' => 'advanced_search_options');
$result = $this->callAPISuccess('setting', 'getfields', $params);
$this->assertArrayNotHasKey('customCSSURL', $result['values']);
- $this->assertArrayHasKey('advanced_search_options',$result['values']);
+ $this->assertArrayHasKey('advanced_search_options', $result['values']);
}
/**
- * Test that getfields will filter on group
+ * Test that getfields will filter on group.
*/
- function testGetFieldsGroupFilters() {
+ public function testGetFieldsGroupFilters() {
$params = array('filters' => array('group' => 'multisite'));
$result = $this->callAPISuccess('setting', 'getfields', $params);
$this->assertArrayNotHasKey('customCSSURL', $result['values']);
- $this->assertArrayHasKey('domain_group_id',$result['values']);
+ $this->assertArrayHasKey('domain_group_id', $result['values']);
}
/**
* Test that getfields will filter on another field (prefetch)
*/
- function testGetFieldsPrefetchFilters() {
+ public function testGetFieldsPrefetchFilters() {
$params = array('filters' => array('prefetch' => 1));
$result = $this->callAPISuccess('setting', 'getfields', $params);
$this->assertArrayNotHasKey('disable_mandatory_tokens_check', $result['values']);
- $this->assertArrayHasKey('monetaryDecimalPoint',$result['values']);
+ $this->assertArrayHasKey('monetaryDecimalPoint', $result['values']);
}
/**
* are very similar, but they exercise different codepaths. The first uses the API
* and setItems [plural]; the second uses setItem [singular].
*/
- function testOnChange() {
+ public function testOnChange() {
global $_testOnChange_hookCalls;
$this->setMockSettingsMetaData(array(
'onChangeExample' => array(
'is_contact' => 0,
'description' => NULL,
'help_text' => NULL,
- 'on_change' => array( // list of callbacks
- array(__CLASS__, '_testOnChange_onChangeExample')
+ 'on_change' => array(// list of callbacks
+ array(__CLASS__, '_testOnChange_onChangeExample'),
),
),
));
* @param $newValue
* @param $metadata
*/
- static function _testOnChange_onChangeExample($oldValue, $newValue, $metadata) {
+ public static function _testOnChange_onChangeExample($oldValue, $newValue, $metadata) {
global $_testOnChange_hookCalls;
$_testOnChange_hookCalls['count']++;
$_testOnChange_hookCalls['oldValue'] = $oldValue;
}
/**
- * Check getfields works
+ * Check getfields works.
*/
- function testCreateSetting() {
- $description = "shows setting a variable for a given domain - if no domain is set current is assumed";
+ public function testCreateSetting() {
+ $description = "Shows setting a variable for a given domain - if no domain is set current is assumed.";
$params = array(
'domain_id' => $this->_domainID2,
);
$result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__);
- $params = array('uniq_email_per_site' => 1,);
- $description = "shows setting a variable for a current domain";
+ $params = array('uniq_email_per_site' => 1);
+ $description = "Shows setting a variable for a current domain.";
$result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__, $description, 'CreateSettingCurrentDomain');
$this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']);
}
/**
- * Check getfields works
+ * Check getfields works.
*/
- function testCreateInvalidSettings() {
+ public function testCreateInvalidSettings() {
$params = array(
'domain_id' => $this->_domainID2,
'invalid_key' => 1,
/**
* Check invalid settings rejected -
*/
- function testCreateInvalidURLSettings() {
+ public function testCreateInvalidURLSettings() {
$params = array(
'domain_id' => $this->_domainID2,
'userFrameworkResourceURL' => 'dfhkdhfd',
}
/**
- * Check getfields works
+ * Check getfields works.
*/
- function testCreateInvalidBooleanSettings() {
+ public function testCreateInvalidBooleanSettings() {
$params = array(
'domain_id' => $this->_domainID2,
'track_civimail_replies' => 'dfhkdhfd',
);
$result = $this->callAPIFailure('setting', 'create', $params);
- $params = array('track_civimail_replies' => '0',);
+ $params = array('track_civimail_replies' => '0');
$result = $this->callAPISuccess('setting', 'create', $params);
- $getResult = $this->callAPISuccess('setting','get',$params);
+ $getResult = $this->callAPISuccess('setting', 'get', $params);
$this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']);
- $getResult = $this->callAPISuccess('setting','get',$params);
+ $getResult = $this->callAPISuccess('setting', 'get', $params);
$this->assertEquals(0, $getResult['values'][$this->_currentDomain]['track_civimail_replies']);
- $params = array( 'domain_id' => $this->_domainID2,
+ $params = array(
+ 'domain_id' => $this->_domainID2,
'track_civimail_replies' => '1',
);
$result = $this->callAPISuccess('setting', 'create', $params);
- $getResult = $this->callAPISuccess('setting','get',$params);
+ $getResult = $this->callAPISuccess('setting', 'get', $params);
$this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies']);
$params = array(
'track_civimail_replies' => 'TRUE',
);
$result = $this->callAPISuccess('setting', 'create', $params);
- $getResult = $this->callAPISuccess('setting','get',$params);
+ $getResult = $this->callAPISuccess('setting', 'get', $params);
$this->assertEquals(1, $getResult['values'][$this->_domainID2]['track_civimail_replies'], "check TRUE is converted to 1");
}
/**
- * Check getfields works
+ * Check getfields works.
*/
- function testCreateSettingMultipleDomains() {
- $description = "shows setting a variable for all domains";
+ public function testCreateSettingMultipleDomains() {
+ $description = "Shows setting a variable for all domains.";
$params = array(
'domain_id' => 'all',
'uniq_email_per_site' => 1,
);
- $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__,$description, 'CreateAllDomains');
+ $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__, $description, 'CreateAllDomains');
$this->assertEquals(1, $result['values'][2]['uniq_email_per_site']);
$this->assertEquals(1, $result['values'][1]['uniq_email_per_site']);
$params = array(
'domain_id' => 'all',
- 'return' => 'uniq_email_per_site'
+ 'return' => 'uniq_email_per_site',
);
// we'll check it with a 'get'
- $description = "shows getting a variable for all domains";
- $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__,$description, 'GetAllDomains', 'Get');
+ $description = "Shows getting a variable for all domains.";
+ $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetAllDomains');
$this->assertEquals(1, $result['values'][2]['uniq_email_per_site']);
$this->assertEquals(1, $result['values'][1]['uniq_email_per_site']);
$this->assertEquals(1, $result['values'][3]['uniq_email_per_site']);
$params = array(
- 'domain_id' => array(1,3),
+ 'domain_id' => array(1, 3),
'uniq_email_per_site' => 0,
);
- $description = "shows setting a variable for specified domains";
- $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__,$description, 'CreateSpecifiedDomains');
+ $description = "Shows setting a variable for specified domains.";
+ $result = $this->callAPIAndDocument('setting', 'create', $params, __FUNCTION__, __FILE__, $description, 'CreateSpecifiedDomains');
$this->assertEquals(0, $result['values'][3]['uniq_email_per_site']);
$this->assertEquals(0, $result['values'][1]['uniq_email_per_site']);
$params = array(
- 'domain_id' => array(1,2),
+ 'domain_id' => array(1, 2),
'return' => array('uniq_email_per_site'),
);
- $description = "shows getting a variable for specified domains";
- $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__,$description, 'GetSpecifiedDomains', 'Get');
+ $description = "Shows getting a variable for specified domains.";
+ $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetSpecifiedDomains');
$this->assertEquals(1, $result['values'][2]['uniq_email_per_site']);
$this->assertEquals(0, $result['values'][1]['uniq_email_per_site']);
}
- function testGetSetting() {
+ public function testGetSetting() {
$params = array(
'domain_id' => $this->_domainID2,
'return' => 'uniq_email_per_site',
);
- $description = "shows get setting a variable for a given domain - if no domain is set current is assumed";
+ $description = "Shows get setting a variable for a given domain - if no domain is set current is assumed.";
- $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__);
+ $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__);
$params = array(
'return' => 'uniq_email_per_site',
);
- $description = "shows getting a variable for a current domain";
- $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetSettingCurrentDomain');
+ $description = "Shows getting a variable for a current domain.";
+ $result = $this->callAPIAndDocument('setting', 'get', $params, __FUNCTION__, __FILE__, $description, 'GetSettingCurrentDomain');
$this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']);
}
/**
- * Check that setting defined in extension can be retrieved
+ * Check that setting defined in extension can be retrieved.
*/
- function testGetExtensionSetting() {
+ public function testGetExtensionSetting() {
$this->hookClass->setHook('civicrm_alterSettingsFolders', array($this, 'setExtensionMetadata'));
$data = NULL;
// the caching of data to all duplicates the caching of data to the empty string
/**
* Setting api should set & fetch settings stored in config as well as those in settings table
*/
- function testSetConfigSetting() {
+ public function testSetConfigSetting() {
$config = CRM_Core_Config::singleton();
$this->assertFalse($config->debug == 1);
$params = array(
/**
* Setting api should set & fetch settings stored in config as well as those in settings table
*/
- function testGetConfigSetting() {
+ public function testGetConfigSetting() {
$settings = $this->callAPISuccess('setting', 'get', array(
- 'name' => 'defaultCurrency', 'sequential' => 1,)
+ 'name' => 'defaultCurrency',
+ 'sequential' => 1,
+ )
);
$this->assertEquals('USD', $settings['values'][0]['defaultCurrency']);
}
/**
* Setting api should set & fetch settings stored in config as well as those in settings table
*/
- function testGetSetConfigSettingMultipleDomains() {
+ public function testGetSetConfigSettingMultipleDomains() {
$settings = $this->callAPISuccess('setting', 'create', array(
- 'defaultCurrency' => 'USD', 'domain_id' => $this->_currentDomain)
+ 'defaultCurrency' => 'USD',
+ 'domain_id' => $this->_currentDomain,
+ )
);
$settings = $this->callAPISuccess('setting', 'create', array(
- 'defaultCurrency' => 'CAD', 'domain_id' => $this->_domainID2)
+ 'defaultCurrency' => 'CAD',
+ 'domain_id' => $this->_domainID2,
+ )
);
$settings = $this->callAPISuccess('setting', 'get', array(
- 'return' => 'defaultCurrency', 'domain_id' => 'all',
+ 'return' => 'defaultCurrency',
+ 'domain_id' => 'all',
)
);
$this->assertEquals('USD', $settings['values'][$this->_currentDomain]['defaultCurrency']);
}
/**
- * Use getValue against a config setting
+ * Use getValue against a config setting.
*/
- function testGetValueConfigSetting() {
- $params = array( 'name' => 'monetaryThousandSeparator',
+ public function testGetValueConfigSetting() {
+ $params = array(
+ 'name' => 'monetaryThousandSeparator',
'group' => 'Localization Setting',
);
$result = $this->callAPISuccess('setting', 'getvalue', $params);
$this->assertEquals(',', $result);
}
- function testGetValue() {
- $params = array( 'name' => 'petition_contacts',
- 'group' => 'Campaign Preferences'
+ public function testGetValue() {
+ $params = array(
+ 'name' => 'petition_contacts',
+ 'group' => 'Campaign Preferences',
);
- $description = "Demonstrates getvalue action - intended for runtime use as better caching than get";
+ $description = "Demonstrates getvalue action - intended for runtime use as better caching than get.";
$result = $this->callAPIAndDocument('setting', 'getvalue', $params, __FUNCTION__, __FILE__, $description);
$this->assertEquals('Petition Contacts', $result);
}
- function testGetDefaults() {
- $description = "gets defaults setting a variable for a given domain - if no domain is set current is assumed";
+ public function testGetDefaults() {
+ $description = "Gets defaults setting a variable for a given domain - if no domain is set current is assumed.";
$params = array(
'name' => 'address_format',
);
- $result = $this->callAPIAndDocument('setting', 'getdefaults', $params, __FUNCTION__, __FILE__,$description,'GetDefaults','getdefaults');
+ $result = $this->callAPIAndDocument('setting', 'getdefaults', $params, __FUNCTION__, __FILE__, $description, 'GetDefaults');
$this->assertEquals("{contact.address_name}\n{contact.street_address}\n{contact.supplemental_address_1}\n{contact.supplemental_address_2}\n{contact.city}{, }{contact.state_province}{ }{contact.postal_code}\n{contact.country}", $result['values'][CRM_Core_Config::domainID()]['address_format']);
- $params = array('name' => 'mailing_format',);
+ $params = array('name' => 'mailing_format');
$result = $this->callAPISuccess('setting', 'getdefaults', $params);
$this->assertEquals("{contact.addressee}\n{contact.street_address}\n{contact.supplemental_address_1}\n{contact.supplemental_address_2}\n{contact.city}{, }{contact.state_province}{ }{contact.postal_code}\n{contact.country}", $result['values'][CRM_Core_Config::domainID()]['mailing_format']);
$this->assertArrayHasKey(CRM_Core_Config::domainID(), $result['values']);
}
/**
- * Function tests reverting a specific parameter
+ * Function tests reverting a specific parameter.
*/
- function testRevert() {
- $params = array( 'address_format' => 'xyz',
+ public function testRevert() {
+ $params = array(
+ 'address_format' => 'xyz',
'mailing_format' => 'bcs',
);
$result = $this->callAPISuccess('setting', 'create', $params);
$this->assertAPISuccess($result, "in line " . __LINE__);
- $revertParams = array( 'name' => 'address_format'
+ $revertParams = array(
+ 'name' => 'address_format',
);
$result = $this->callAPISuccess('setting', 'get', $params);
//make sure it's set
$this->assertEquals('xyz', $result['values'][CRM_Core_Config::domainID()]['address_format']);
- $description = "Demonstrates reverting a parameter to default value";
- $result = $this->callAPIAndDocument('setting', 'revert', $revertParams, __FUNCTION__, __FILE__,$description,'','revert');
+ $description = "Demonstrates reverting a parameter to default value.";
+ $result = $this->callAPIAndDocument('setting', 'revert', $revertParams, __FUNCTION__, __FILE__, $description, '');
//make sure it's reverted
$result = $this->callAPISuccess('setting', 'get', $params);
$this->assertEquals("{contact.address_name}\n{contact.street_address}\n{contact.supplemental_address_1}\n{contact.supplemental_address_2}\n{contact.city}{, }{contact.state_province}{ }{contact.postal_code}\n{contact.country}", $result['values'][CRM_Core_Config::domainID()]['address_format']);
- $params = array( 'return' => array('mailing_format'),
+ $params = array(
+ 'return' => array('mailing_format'),
);
$result = $this->callAPISuccess('setting', 'get', $params);
//make sure it's unchanged
/**
* Tests reverting ALL parameters (specific domain)
*/
- function testRevertAll() {
- $params = array( 'address_format' => 'xyz',
+ public function testRevertAll() {
+ $params = array(
+ 'address_format' => 'xyz',
'mailing_format' => 'bcs',
);
$result = $this->callAPISuccess('setting', 'create', $params);
- $revertParams = array( );
+ $revertParams = array();
$result = $this->callAPISuccess('setting', 'get', $params);
//make sure it's set
$this->assertEquals('xyz', $result['values'][CRM_Core_Config::domainID()]['address_format']);
}
/**
- * Tests filling missing params
+ * Tests filling missing params.
*/
- function testFill() {
+ public function testFill() {
$domparams = array(
'name' => 'B Team Domain',
);
$dom = $this->callAPISuccess('domain', 'create', $domparams);
- $params = array( 'domain_id' => 'all',
+ $params = array(
+ 'domain_id' => 'all',
);
$result = $this->callAPISuccess('setting', 'get', $params);
- $params = array( 'address_format' => 'xyz',
+ $params = array(
+ 'address_format' => 'xyz',
'mailing_format' => 'bcs',
'domain_id' => $this->_domainID2,
);
$result = $this->callAPISuccess('setting', 'create', $params);
- $params = array( 'domain_id' => $dom['id'],
+ $params = array(
+ 'domain_id' => $dom['id'],
);
$result = $this->callAPISuccess('setting', 'get', $params);
$this->assertAPISuccess($result, "in line " . __LINE__);
- $this->assertArrayNotHasKey('tag_unconfirmed', $result['values'][$dom['id']],'setting for domain 3 should not be set. Debug this IF domain test is passing');
+ $this->assertArrayNotHasKey('tag_unconfirmed', $result['values'][$dom['id']], 'setting for domain 3 should not be set. Debug this IF domain test is passing');
$result = $this->callAPISuccess('setting', 'fill', $params);
$this->assertAPISuccess($result, "in line " . __LINE__);
$result = $this->callAPISuccess('setting', 'get', $params);
$this->assertArrayHasKey('extensionsDir', $result['values'][$dom['id']]);
$this->assertEquals('Unconfirmed', $result['values'][$dom['id']]['tag_unconfirmed']);
}
-}
+}
projects / civicrm-core.git / blobdiff