api/v3/examples/Contact/CustomFieldGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using contact get API
   4  * /*this demonstrates setting a custom field through the API  *
   5  */
   6 function contact_get_example(){
   7 $params = array(
   8   'return.custom_1' => 1,
   9   'id' => 1,
  10 );
  11
  12 try{
  13   $result = civicrm_api3('contact', 'get', $params);
  14 }
  15 catch (CiviCRM_API3_Exception $e) {
  16   // handle error here
  17   $errorMessage = $e->getMessage();
  18   $errorCode = $e->getErrorCode();
  19   $errorData = $e->getExtraParams();
  20   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  21 }
  22
  23 return $result;
  24 }
  25
  26 /**
  27  * Function returns array of result expected from previous function
  28  */
  29 function contact_get_expectedresult(){
  30
  31   $expectedResult = array(
  32   'is_error' => 0,
  33   'version' => 3,
  34   'count' => 1,
  35   'id' => 1,
  36   'values' => array(
  37       '1' => array(
  38           'contact_id' => '1',
  39           'civicrm_value_testgetwithcu_1_id' => '1',
  40           'custom_1' => 'custom string',
  41           'id' => '1',
  42         ),
  43     ),
  44 );
  45
  46   return $expectedResult;
  47 }
  48
  49
  50 /*
  51 * This example has been generated from the API test suite. The test that created it is called
  52 *
  53 * testGetWithCustom and can be found in
  54 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
  55 *
  56 * You can see the outcome of the API tests at
  57 * http://tests.dev.civicrm.org/trunk/results-api_v3
  58 *
  59 * To Learn about the API read
  60 * http://book.civicrm.org/developer/current/techniques/api/
  61 *
  62 * and review the wiki at
  63 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  64 *
  65 * Read more about testing here
  66 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  67 *
  68 * API Standards documentation:
  69 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  70 */