api/v3/examples/Tag/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using tag create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function tag_create_example() {
   9   $params = array(
  10     'name' => 'Super Heros',
  11     'description' => 'Outside undie-wearers',
  12   );
  13
  14   try{
  15     $result = civicrm_api3('tag', 'create', $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(
  23       'error' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function tag_create_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 12,
  45     'values' => array(
  46       '12' => array(
  47         'id' => '12',
  48         'name' => 'Super Heros',
  49         'description' => 'Outside undie-wearers',
  50         'parent_id' => '',
  51         'is_selectable' => '',
  52         'is_reserved' => '',
  53         'is_tagset' => '',
  54         'used_for' => 'civicrm_contact',
  55         'created_id' => '',
  56         'created_date' => '2013-07-28 08:49:19',
  57       ),
  58     ),
  59   );
  60
  61   return $expectedResult;
  62 }
  63
  64 /**
  65 * This example has been generated from the API test suite.
  66 * The test that created it is called
  67 * testCreate
  68 * and can be found in
  69 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php
  70 *
  71 * You can see the outcome of the API tests at
  72 * https://test.civicrm.org/job/CiviCRM-master-git/
  73 *
  74 * To Learn about the API read
  75 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  76 *
  77 * Browse the api on your own site with the api explorer
  78 * http://MYSITE.ORG/path/to/civicrm/api
  79 *
  80 * Read more about testing here
  81 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  82 *
  83 * API Standards documentation:
  84 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  85 */