12012f6949561078daff496d4ebf1d5f543b0717
3 * Test Generated example demonstrating the Contact.getactions API.
5 * Getting the available actions for an entity.
10 function contact_getactions_example() {
14 $result = civicrm_api3('Contact', 'getactions', $params);
16 catch (CiviCRM_API3_Exception
$e) {
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
22 'error' => $errorMessage,
23 'error_code' => $errorCode,
24 'error_data' => $errorData,
32 * Function returns array of result expected from previous function.
37 function contact_getactions_expectedresult() {
39 $expectedResult = array(
46 '2' => 'example_action1',
47 '3' => 'example_action2',
55 '11' => 'getrefcount',
63 '19' => 'type_create',
64 '20' => 'type_delete',
68 'deprecated' => array(
69 'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
70 'setvalue' => 'The "setvalue" action is deprecated. Use "create" with an id instead.',
71 'update' => 'The "update" action is deprecated. Use "create" with an id instead.',
75 return $expectedResult;
79 * This example has been generated from the API test suite.
80 * The test that created it is called "testGetActions"
81 * and can be found at:
82 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
84 * You can see the outcome of the API tests at
85 * https://test.civicrm.org/job/CiviCRM-master-git/
87 * To Learn about the API read
88 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
90 * Browse the api on your own site with the api explorer
91 * http://MYSITE.ORG/path/to/civicrm/api
93 * Read more about testing here
94 * http://wiki.civicrm.org/confluence/display/CRM/Testing
96 * API Standards documentation:
97 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards