api/v3/examples/Tag/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using tag get API.
   4  *
   5  *
   6  * @return array
   7  *   API result array
   8  */
   9 function tag_get_example() {
  10   $params = array(
  11     'id' => '7',
  12     'name' => 'New Tag3',
  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(
  24       'error' => $errorMessage,
  25       'error_code' => $errorCode,
  26       'error_data' => $errorData,
  27     );
  28   }
  29
  30   return $result;
  31 }
  32
  33 /**
  34  * Function returns array of result expected from previous function.
  35  *
  36  * @return array
  37  *   API result array
  38  */
  39 function tag_get_expectedresult() {
  40
  41   $expectedResult = array(
  42     'is_error' => 0,
  43     'version' => 3,
  44     'count' => 1,
  45     'id' => 7,
  46     'values' => array(
  47       '7' => array(
  48         'id' => '7',
  49         'name' => 'New Tag3',
  50         'description' => 'This is description for Our New Tag ',
  51         'is_selectable' => '1',
  52         'is_reserved' => 0,
  53         'is_tagset' => 0,
  54         'used_for' => 'civicrm_contact',
  55         'created_date' => '2013-07-28 08:49:19',
  56       ),
  57     ),
  58   );
  59
  60   return $expectedResult;
  61 }
  62
  63 /**
  64 * This example has been generated from the API test suite.
  65 * The test that created it is called
  66 * testGet
  67 * and can be found in
  68 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php
  69 *
  70 * You can see the outcome of the API tests at
  71 * https://test.civicrm.org/job/CiviCRM-master-git/
  72 *
  73 * To Learn about the API read
  74 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  75 *
  76 * Browse the api on your own site with the api explorer
  77 * http://MYSITE.ORG/path/to/civicrm/api
  78 *
  79 * Read more about testing here
  80 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  81 *
  82 * API Standards documentation:
  83 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  84 */