Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-01-18-17-02-24
[civicrm-core.git] / api / v3 / examples / EntityTagDelete.php
1 <?php
2 /**
3 * Test Generated example of using entity_tag delete API
4 * *
5 */
6 function entity_tag_delete_example(){
7 $params = array(
8 'contact_id_h' => 37,
9 'tag_id' => '1',
10 );
11
12 try{
13 $result = civicrm_api3('entity_tag', 'delete', $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 entity_tag_delete_expectedresult(){
30
31 $expectedResult = array(
32 'is_error' => 0,
33 'not_removed' => 0,
34 'removed' => 1,
35 'total_count' => 1,
36 );
37
38 return $expectedResult;
39 }
40
41
42 /*
43 * This example has been generated from the API test suite. The test that created it is called
44 *
45 * testEntityTagDeleteHH and can be found in
46 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/EntityTagTest.php
47 *
48 * You can see the outcome of the API tests at
49 * http://tests.dev.civicrm.org/trunk/results-api_v3
50 *
51 * To Learn about the API read
52 * http://book.civicrm.org/developer/current/techniques/api/
53 *
54 * and review the wiki at
55 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
56 *
57 * Read more about testing here
58 * http://wiki.civicrm.org/confluence/display/CRM/Testing
59 *
60 * API Standards documentation:
61 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
62 */