api/v3/examples/Setting/Revert.php

   1 <?php
   2 /**
   3  * Test Generated example of using setting revert API.
   4  *
   5  * Demonstrates reverting a parameter to default value.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function setting_revert_example() {
  11   $params = array(
  12     'name' => 'address_format',
  13   );
  14
  15   try{
  16     $result = civicrm_api3('setting', 'revert', $params);
  17   }
  18   catch (CiviCRM_API3_Exception $e) {
  19     // Handle error here.
  20     $errorMessage = $e->getMessage();
  21     $errorCode = $e->getErrorCode();
  22     $errorData = $e->getExtraParams();
  23     return array(
  24       'error' => $errorMessage,
  25       'error_code' => $errorCode,
  26       'error_data' => $errorData,
  27     );
  28   }
  29
  30   return $result;
  31 }
  32
  33 /**
  34  * Function returns array of result expected from previous function.
  35  *
  36  * @return array
  37  *   API result array
  38  */
  39 function setting_revert_expectedresult() {
  40
  41   $expectedResult = array(
  42     'is_error' => 0,
  43     'version' => 3,
  44     'count' => 5,
  45     'id' => 1,
  46     'values' => array(
  47       'is_error' => 0,
  48       'version' => 3,
  49       'count' => 1,
  50       'id' => 1,
  51       'values' => array(
  52         '1' => array(
  53           'address_format' => '{contact.address_name}
  54 {contact.street_address}
  55 {contact.supplemental_address_1}
  56 {contact.supplemental_address_2}
  57 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
  58 {contact.country}',
  59         ),
  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 * testRevert
  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
  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 */