api/v3/examples/Contact/FormatSingleValue.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Contact.getvalue API.
   4  *
   5  * This demonstrates use of the 'format.single_value' param.
   6  * This param causes only a single value of the only entity to be returned as an string.
   7  * It will be ignored if there is not exactly 1 result
   8  *
   9  * @return array
  10  *   API result array
  11  */
  12 function contact_getvalue_example() {
  13   $params = array(
  14     'id' => 17,
  15     'return' => 'display_name',
  16   );
  17
  18   try{
  19     $result = civicrm_api3('Contact', 'getvalue', $params);
  20   }
  21   catch (CiviCRM_API3_Exception $e) {
  22     // Handle error here.
  23     $errorMessage = $e->getMessage();
  24     $errorCode = $e->getErrorCode();
  25     $errorData = $e->getExtraParams();
  26     return array(
  27       'is_error' => 1,
  28       'error_message' => $errorMessage,
  29       'error_code' => $errorCode,
  30       'error_data' => $errorData,
  31     );
  32   }
  33
  34   return $result;
  35 }
  36
  37 /**
  38  * Function returns array of result expected from previous function.
  39  *
  40  * @return array
  41  *   API result array
  42  */
  43 function contact_getvalue_expectedresult() {
  44
  45   $expectedResult = 'Test Contact';
  46
  47   return $expectedResult;
  48 }
  49
  50 /*
  51 * This example has been generated from the API test suite.
  52 * The test that created it is called "testContactGetFormatSingleValue"
  53 * and can be found at:
  54 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
  55 *
  56 * You can see the outcome of the API tests at
  57 * https://test.civicrm.org/job/CiviCRM-master-git/
  58 *
  59 * To Learn about the API read
  60 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  61 *
  62 * Browse the api on your own site with the api explorer
  63 * http://MYSITE.ORG/path/to/civicrm/api
  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 */