api/v3/examples/TagGetList.php

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