api/v3/examples/TagGetList.php

   1 <?php
   2 /**
   3  * Test Generated example of using tag getlist API
   4  * *
   5  */
   6 function tag_getlist_example(){
   7 $params = array(
   8   'input' => 'New Tag3',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('tag', 'getlist', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function tag_getlist_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'id' => 0,
  35   'values' => array(
  36       '0' => array(
  37           'id' => '6',
  38           'label' => 'New Tag3',
  39           'description' => 'This is description for Our New Tag ',
  40           'image' => '',
  41         ),
  42     ),
  43   'more_results' => '',
  44   'page_num' => 1,
  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 * testTagGetList 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 */