api/v3/examples/TagGet.php

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