api/v3/examples/Setting/Revert.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the 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 = [
  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 [
  24       'is_error' => 1,
  25       'error_message' => $errorMessage,
  26       'error_code' => $errorCode,
  27       'error_data' => $errorData,
  28     ];
  29   }
  30
  31   return $result;
  32 }
  33
  34 /**
  35  * Function returns array of result expected from previous function.
  36  *
  37  * @return array
  38  *   API result array
  39  */
  40 function setting_revert_expectedresult() {
  41
  42   $expectedResult = [
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 5,
  46     'id' => 1,
  47     'values' => [
  48       'is_error' => 0,
  49       'version' => 3,
  50       'count' => 1,
  51       'id' => 1,
  52       'values' => [
  53         '1' => [
  54           'address_format' => '{contact.address_name}
  55 {contact.street_address}
  56 {contact.supplemental_address_1}
  57 {contact.supplemental_address_2}
  58 {contact.supplemental_address_3}
  59 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
  60 {contact.country}',
  61         ],
  62       ],
  63     ],
  64   ];
  65
  66   return $expectedResult;
  67 }
  68
  69 /*
  70 * This example has been generated from the API test suite.
  71 * The test that created it is called "testRevert"
  72 * and can be found at:
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  77 *
  78 * To Learn about the API read
  79 * https://docs.civicrm.org/dev/en/latest/api/
  80 *
  81 * Browse the API on your own site with the API Explorer. It is in the main
  82 * CiviCRM menu, under: Support > Development > API Explorer.
  83 *
  84 * Read more about testing here
  85 * https://docs.civicrm.org/dev/en/latest/testing/
  86 *
  87 * API Standards documentation:
  88 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  89 */