api/v3/examples/Tag/GetList.php

   1 <?php
   2 /**
   3  * Test Generated example of using tag getlist API
   4  * Demonstrates use of api.getlist for autocomplete and quicksearch applications *
   5  */
   6 function tag_getlist_example(){
   7 $params = array(
   8   'input' => 'New Tag3',
   9   'extra' => array(
  10       '0' => 'used_for',
  11     ),
  12 );
  13
  14 try{
  15   $result = civicrm_api3('tag', 'getlist', $params);
  16 }
  17 catch (CiviCRM_API3_Exception $e) {
  18   // handle error here
  19   $errorMessage = $e->getMessage();
  20   $errorCode = $e->getErrorCode();
  21   $errorData = $e->getExtraParams();
  22   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function tag_getlist_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 0,
  38   'values' => array(
  39       '0' => array(
  40           'id' => '19',
  41           'label' => 'New Tag3',
  42           'description' => array(
  43               '0' => 'This is description for Our New Tag ',
  44             ),
  45           'extra' => array(
  46               'used_for' => 'civicrm_contact',
  47             ),
  48         ),
  49     ),
  50   'page_num' => 1,
  51   'more_results' => '',
  52 );
  53
  54   return $expectedResult;
  55 }
  56
  57
  58 /*
  59 * This example has been generated from the API test suite. The test that created it is called
  60 *
  61 * testTagGetList and can be found in
  62 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php
  63 *
  64 * You can see the outcome of the API tests at
  65 * https://test.civicrm.org/job/CiviCRM-master-git/
  66 *
  67 * To Learn about the API read
  68 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  69 *
  70 * Browse the api on your own site with the api explorer
  71 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  72 *
  73 * Read more about testing here
  74 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  75 *
  76 * API Standards documentation:
  77 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  78 */