Commit | Line | Data |
---|---|---|
7f254ad8 AE |
1 | <?php |
2 | /** | |
3 | * Test Generated example demonstrating the Tag.get API. | |
4 | * | |
5 | * @return array | |
6 | * API result array | |
7 | */ | |
8 | function tag_get_example() { | |
9 | $params = array( | |
10 | 'id' => '7', | |
11 | 'name' => 'New Tag3', | |
12 | ); | |
13 | ||
14 | try{ | |
15 | $result = civicrm_api3('Tag', 'get', $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_get_expectedresult() { | |
39 | ||
40 | $expectedResult = array( | |
41 | 'is_error' => 0, | |
42 | 'version' => 3, | |
43 | 'count' => 1, | |
44 | 'id' => 7, | |
45 | 'values' => array( | |
46 | '7' => array( | |
47 | 'id' => '7', | |
48 | 'name' => 'New Tag3', | |
49 | 'description' => 'This is description for Our New Tag ', | |
50 | 'is_selectable' => '1', | |
51 | 'is_reserved' => 0, | |
52 | 'is_tagset' => 0, | |
53 | 'used_for' => 'civicrm_contact', | |
54 | 'created_date' => '2013-07-28 08:49:19', | |
55 | ), | |
56 | ), | |
57 | ); | |
58 | ||
59 | return $expectedResult; | |
60 | } | |
61 | ||
62 | /* | |
63 | * This example has been generated from the API test suite. | |
64 | * The test that created it is called "testGet" | |
65 | * and can be found at: | |
66 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php | |
67 | * | |
68 | * You can see the outcome of the API tests at | |
69 | * https://test.civicrm.org/job/CiviCRM-master-git/ | |
70 | * | |
71 | * To Learn about the API read | |
72 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API | |
73 | * | |
74 | * Browse the api on your own site with the api explorer | |
75 | * http://MYSITE.ORG/path/to/civicrm/api | |
76 | * | |
77 | * Read more about testing here | |
78 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
79 | * | |
80 | * API Standards documentation: | |
81 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
82 | */ |