api/v3/examples/Setting/GetDefaults.php

   1 <?php
   2 /**
   3  * @file
   4  * Test Generated API Example.
   5  * See bottom of this file for more detail.
   6  */
   7
   8 /**
   9  * Test Generated example of using setting getdefaults API.
  10  *
  11  * gets defaults setting a variable for a given domain - if no domain is set current is assumed
  12  *
  13  * @return array
  14  *   API result array
  15  */
  16 function setting_getdefaults_example() {
  17   $params = array(
  18     'name' => 'address_format',
  19   );
  20
  21   try{
  22     $result = civicrm_api3('setting', 'getdefaults', $params);
  23   }
  24   catch (CiviCRM_API3_Exception $e) {
  25     // Handle error here.
  26     $errorMessage = $e->getMessage();
  27     $errorCode = $e->getErrorCode();
  28     $errorData = $e->getExtraParams();
  29     return array(
  30       'error' => $errorMessage,
  31       'error_code' => $errorCode,
  32       'error_data' => $errorData,
  33     );
  34   }
  35
  36   return $result;
  37 }
  38
  39 /**
  40  * Function returns array of result expected from previous function.
  41  *
  42  * @return array
  43  *   API result array
  44  */
  45 function setting_getdefaults_expectedresult() {
  46
  47   $expectedResult = array(
  48     'is_error' => 0,
  49     'version' => 3,
  50     'count' => 1,
  51     'id' => 1,
  52     'values' => array(
  53       '1' => array(
  54         'address_format' => '{contact.address_name}
  55 {contact.street_address}
  56 {contact.supplemental_address_1}
  57 {contact.supplemental_address_2}
  58 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
  59 {contact.country}',
  60       ),
  61     ),
  62   );
  63
  64   return $expectedResult;
  65 }
  66
  67 /**
  68 * This example has been generated from the API test suite.
  69 * The test that created it is called
  70 * testGetDefaults
  71 * and can be found in
  72 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
  73 *
  74 * You can see the outcome of the API tests at
  75 * https://test.civicrm.org/job/CiviCRM-master-git/
  76 *
  77 * To Learn about the API read
  78 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  79 *
  80 * Browse the api on your own site with the api explorer
  81 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  82 *
  83 * Read more about testing here
  84 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  85 *
  86 * API Standards documentation:
  87 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  88 */