api/v3/examples/Contact/Getoptions.php

   1 <?php
   2 /**
   3  * Test Generated example of using contact getoptions API
   4  * Demonstrates retrieving options for a custom field *
   5  */
   6 function contact_getoptions_example(){
   7 $params = array(
   8   'field' => 'custom_1',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('contact', 'getoptions', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function contact_getoptions_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 2,
  34   'values' => array(
  35       '1' => 'Label1',
  36       '2' => 'Label2',
  37     ),
  38 );
  39
  40   return $expectedResult;
  41 }
  42
  43
  44 /*
  45 * This example has been generated from the API test suite. The test that created it is called
  46 *
  47 * testCustomFieldCreateWithOptionValues and can be found in
  48 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  49 *
  50 * You can see the outcome of the API tests at
  51 * https://test.civicrm.org/job/CiviCRM-master-git/
  52 *
  53 * To Learn about the API read
  54 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  55 *
  56 * Browse the api on your own site with the api explorer
  57 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  58 *
  59 * Read more about testing here
  60 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  61 *
  62 * API Standards documentation:
  63 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  64 */