crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/Tag/GetReturnArray.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Tag.get API.
   4  *
   5  * Demonstrates use of Return as an array.
   6  *
   7  * @return array
   8  *   API result array
   9  */
  10 function tag_get_example() {
  11   $params = array(
  12     'id' => '8',
  13     'name' => 'New Tag3',
  14     'return' => array(
  15       '0' => 'name',
  16     ),
  17   );
  18
  19   try{
  20     $result = civicrm_api3('Tag', 'get', $params);
  21   }
  22   catch (CiviCRM_API3_Exception $e) {
  23     // Handle error here.
  24     $errorMessage = $e->getMessage();
  25     $errorCode = $e->getErrorCode();
  26     $errorData = $e->getExtraParams();
  27     return array(
  28       'error' => $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 tag_get_expectedresult() {
  44
  45   $expectedResult = array(
  46     'is_error' => 0,
  47     'version' => 3,
  48     'count' => 1,
  49     'id' => 8,
  50     'values' => array(
  51       '8' => array(
  52         'id' => '8',
  53         'name' => 'New Tag3',
  54       ),
  55     ),
  56   );
  57
  58   return $expectedResult;
  59 }
  60
  61 /*
  62 * This example has been generated from the API test suite.
  63 * The test that created it is called "testGetReturnArray"
  64 * and can be found at:
  65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.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 */