api/v3/examples/Tag/getReturnArray.php

   1 <?php
   2 /**
   3  * Test Generated example of using tag get API
   4  * demonstrates use of Return as an array *
   5  */
   6 function tag_get_example(){
   7 $params = array(
   8   'id' => '8',
   9   'name' => 'New Tag3',
  10   'return' => array(
  11       '0' => 'name',
  12     ),
  13 );
  14
  15 try{
  16   $result = civicrm_api3('tag', 'get', $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('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  24 }
  25
  26 return $result;
  27 }
  28
  29 /**
  30  * Function returns array of result expected from previous function
  31  */
  32 function tag_get_expectedresult(){
  33
  34   $expectedResult = array(
  35   'is_error' => 0,
  36   'version' => 3,
  37   'count' => 1,
  38   'id' => 8,
  39   'values' => array(
  40       '8' => array(
  41           'id' => '8',
  42           'name' => 'New Tag3',
  43         ),
  44     ),
  45 );
  46
  47   return $expectedResult;
  48 }
  49
  50
  51 /*
  52 * This example has been generated from the API test suite. The test that created it is called
  53 *
  54 * testGetReturnArray and can be found in
  55 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/TagTest.php
  56 *
  57 * You can see the outcome of the API tests at
  58 * http://tests.dev.civicrm.org/trunk/results-api_v3
  59 *
  60 * To Learn about the API read
  61 * http://book.civicrm.org/developer/current/techniques/api/
  62 *
  63 * and review the wiki at
  64 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  65 *
  66 * Read more about testing here
  67 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  68 *
  69 * API Standards documentation:
  70 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  71 */