api/v3/examples/TagCreate.php

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