api/v3/examples/OptionGroup/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the OptionGroup.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function option_group_get_example() {
   9   $params = array(
  10     'name' => 'preferred_communication_method',
  11   );
  12
  13   try{
  14     $result = civicrm_api3('OptionGroup', 'get', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return array(
  22       'is_error' => 1,
  23       'error_message' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function option_group_get_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 1,
  45     'values' => array(
  46       '1' => array(
  47         'id' => '1',
  48         'name' => 'preferred_communication_method',
  49         'title' => 'Preferred Communication Method',
  50         'is_reserved' => '1',
  51         'is_active' => '1',
  52         'is_locked' => 0,
  53       ),
  54     ),
  55   );
  56
  57   return $expectedResult;
  58 }
  59
  60 /*
  61 * This example has been generated from the API test suite.
  62 * The test that created it is called "testGetOptionGroupByName"
  63 * and can be found at:
  64 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/OptionGroupTest.php
  65 *
  66 * You can see the outcome of the API tests at
  67 * https://test.civicrm.org/job/CiviCRM-master-git/
  68 *
  69 * To Learn about the API read
  70 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  71 *
  72 * Browse the api on your own site with the api explorer
  73 * http://MYSITE.ORG/path/to/civicrm/api
  74 *
  75 * Read more about testing here
  76 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  77 *
  78 * API Standards documentation:
  79 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  80 */