Commit | Line | Data |
---|---|---|
92776611 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Contact.getactions API. |
50fb255d | 4 | * |
5 | * Getting the available actions for an entity. | |
6 | * | |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function contact_getactions_example() { | |
11 | $params = array(); | |
92776611 | 12 | |
50fb255d | 13 | try{ |
a828d7b8 | 14 | $result = civicrm_api3('Contact', 'getactions', $params); |
50fb255d | 15 | } |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // Handle error here. | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
21 | return array( | |
22 | 'error' => $errorMessage, | |
23 | 'error_code' => $errorCode, | |
24 | 'error_data' => $errorData, | |
25 | ); | |
26 | } | |
27 | ||
28 | return $result; | |
92776611 CW |
29 | } |
30 | ||
31 | /** | |
50fb255d | 32 | * Function returns array of result expected from previous function. |
33 | * | |
34 | * @return array | |
35 | * API result array | |
92776611 | 36 | */ |
50fb255d | 37 | function contact_getactions_expectedresult() { |
92776611 CW |
38 | |
39 | $expectedResult = array( | |
50fb255d | 40 | 'is_error' => 0, |
41 | 'version' => 3, | |
a828d7b8 | 42 | 'count' => 23, |
50fb255d | 43 | 'values' => array( |
92776611 CW |
44 | '0' => 'create', |
45 | '1' => 'delete', | |
a828d7b8 CW |
46 | '2' => 'example_action1', |
47 | '3' => 'example_action2', | |
48 | '4' => 'get', | |
49 | '5' => 'getactions', | |
50 | '6' => 'getcount', | |
51 | '7' => 'getfields', | |
52 | '8' => 'getlist', | |
53 | '9' => 'getoptions', | |
54 | '10' => 'getquick', | |
55 | '11' => 'getrefcount', | |
56 | '12' => 'getsingle', | |
57 | '13' => 'getstat', | |
58 | '14' => 'getvalue', | |
59 | '15' => 'merge', | |
60 | '16' => 'proximity', | |
61 | '17' => 'replace', | |
62 | '18' => 'setvalue', | |
63 | '19' => 'type_create', | |
64 | '20' => 'type_delete', | |
65 | '21' => 'type_get', | |
66 | '22' => 'update', | |
92776611 | 67 | ), |
50fb255d | 68 | 'deprecated' => array( |
92776611 CW |
69 | 'getquick' => 'The "getquick" action is deprecated in favor of "getlist".', |
70 | 'update' => 'The "update" action is deprecated. Use "create" with an id instead.', | |
71 | ), | |
50fb255d | 72 | ); |
92776611 CW |
73 | |
74 | return $expectedResult; | |
75 | } | |
76 | ||
a828d7b8 | 77 | /* |
50fb255d | 78 | * This example has been generated from the API test suite. |
a828d7b8 CW |
79 | * The test that created it is called "testGetActions" |
80 | * and can be found at: | |
92776611 CW |
81 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php |
82 | * | |
83 | * You can see the outcome of the API tests at | |
84 | * https://test.civicrm.org/job/CiviCRM-master-git/ | |
85 | * | |
86 | * To Learn about the API read | |
87 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API | |
88 | * | |
89 | * Browse the api on your own site with the api explorer | |
41d4d31f | 90 | * http://MYSITE.ORG/path/to/civicrm/api |
92776611 CW |
91 | * |
92 | * Read more about testing here | |
93 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
94 | * | |
95 | * API Standards documentation: | |
96 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
97 | */ |