crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/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 = array(
  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 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 contact_getoptions_expectedresult() {
  40
  41   $expectedResult = array(
  42     'is_error' => 0,
  43     'version' => 3,
  44     'count' => 2,
  45     'values' => array(
  46       '1' => 'Label1',
  47       '2' => 'Label2',
  48     ),
  49   );
  50
  51   return $expectedResult;
  52 }
  53
  54 /*
  55 * This example has been generated from the API test suite.
  56 * The test that created it is called "testCustomFieldCreateWithOptionValues"
  57 * and can be found at:
  58 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  59 *
  60 * You can see the outcome of the API tests at
  61 * https://test.civicrm.org/job/CiviCRM-master-git/
  62 *
  63 * To Learn about the API read
  64 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  65 *
  66 * Browse the api on your own site with the api explorer
  67 * http://MYSITE.ORG/path/to/civicrm/api
  68 *
  69 * Read more about testing here
  70 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  71 *
  72 * API Standards documentation:
  73 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  74 */