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