<?php
/**
- * Test Generated example of using contact getactions API
- * Getting the available actions for an entity. *
+ * Test Generated example of using contact getactions API.
+ *
+ * Getting the available actions for an entity.
+ *
+ * @return array
+ * API result array
*/
-function contact_getactions_example(){
-$params = array();
+function contact_getactions_example() {
+ $params = array();
-try{
- $result = civicrm_api3('contact', 'getactions', $params);
-}
-catch (CiviCRM_API3_Exception $e) {
- // handle error here
- $errorMessage = $e->getMessage();
- $errorCode = $e->getErrorCode();
- $errorData = $e->getExtraParams();
- return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}
+ try{
+ $result = civicrm_api3('contact', 'getactions', $params);
+ }
+ catch (CiviCRM_API3_Exception $e) {
+ // Handle error here.
+ $errorMessage = $e->getMessage();
+ $errorCode = $e->getErrorCode();
+ $errorData = $e->getExtraParams();
+ return array(
+ 'error' => $errorMessage,
+ 'error_code' => $errorCode,
+ 'error_data' => $errorData,
+ );
+ }
-return $result;
+ return $result;
}
/**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
*/
-function contact_getactions_expectedresult(){
+function contact_getactions_expectedresult() {
$expectedResult = array(
- 'is_error' => 0,
- 'version' => 3,
- 'count' => 17,
- 'values' => array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 18,
+ 'values' => array(
'0' => 'create',
'1' => 'delete',
'2' => 'get',
'8' => 'getquick',
'9' => 'getrefcount',
'10' => 'getsingle',
- '11' => 'getvalue',
- '12' => 'merge',
- '13' => 'proximity',
- '14' => 'replace',
- '15' => 'setvalue',
- '16' => 'update',
+ '11' => 'getstat',
+ '12' => 'getvalue',
+ '13' => 'merge',
+ '14' => 'proximity',
+ '15' => 'replace',
+ '16' => 'setvalue',
+ '17' => 'update',
),
- 'deprecated' => array(
+ 'deprecated' => array(
'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
'update' => 'The "update" action is deprecated. Use "create" with an id instead.',
),
-);
+ );
return $expectedResult;
}
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetActions and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testGetActions
+* and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
*
* You can see the outcome of the API tests at
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
-* http://MYSITE.ORG/path/to/civicrm/api/explorer
+* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing