api/v3/examples/Contact/GetOptions.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Contact.getoptions API.
   4  *
   5  * Demonstrates retrieving options for a custom field.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function contact_getoptions_example() {
  11   $params = [
  12     'field' => 'custom_1',
  13   ];
  14
  15   try{
  16     $result = civicrm_api3('Contact', 'getoptions', $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 contact_getoptions_expectedresult() {
  41
  42   $expectedResult = [
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 2,
  46     'values' => [
  47       '1' => 'Label1',
  48       '2' => 'Label2',
  49     ],
  50   ];
  51
  52   return $expectedResult;
  53 }
  54
  55 /*
  56 * This example has been generated from the API test suite.
  57 * The test that created it is called "testCustomFieldCreateWithOptionValues"
  58 * and can be found at:
  59 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  60 *
  61 * You can see the outcome of the API tests at
  62 * https://test.civicrm.org/job/CiviCRM-master-git/
  63 *
  64 * To Learn about the API read
  65 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  66 *
  67 * Browse the api on your own site with the api explorer
  68 * http://MYSITE.ORG/path/to/civicrm/api
  69 *
  70 * Read more about testing here
  71 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  72 *
  73 * API Standards documentation:
  74 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  75 */