api/v3/examples/Contact/CustomFieldGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using contact get API.
   4  *
   5  * /*this demonstrates setting a custom field through the API
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function contact_get_example() {
  11   $params = array(
  12     'return.custom_1' => 1,
  13     'id' => 1,
  14   );
  15
  16   try{
  17     $result = civicrm_api3('contact', 'get', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return array(
  25       'error' => $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_get_expectedresult() {
  41
  42   $expectedResult = array(
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 1,
  46     'id' => 1,
  47     'values' => array(
  48       '1' => array(
  49         'contact_id' => '1',
  50         'civicrm_value_testgetwithcu_1_id' => '1',
  51         'custom_1' => 'custom string',
  52         'id' => '1',
  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
  63 * testGetWithCustom
  64 * and can be found in
  65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  66 *
  67 * You can see the outcome of the API tests at
  68 * https://test.civicrm.org/job/CiviCRM-master-git/
  69 *
  70 * To Learn about the API read
  71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  72 *
  73 * Browse the api on your own site with the api explorer
  74 * http://MYSITE.ORG/path/to/civicrm/api
  75 *
  76 * Read more about testing here
  77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  78 *
  79 * API Standards documentation:
  80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  81 */