<?php
/**
- * Test Generated example of using tag get API
- * demonstrates use of Return as an array *
+ * Test Generated example of using tag get API.
+ *
+ * demonstrates use of Return as an array
+ *
+ * @return array
+ * API result array
*/
-function tag_get_example(){
-$params = array(
- 'id' => '8',
- 'name' => 'New Tag3',
- 'return' => array(
+function tag_get_example() {
+ $params = array(
+ 'id' => '8',
+ 'name' => 'New Tag3',
+ 'return' => array(
'0' => 'name',
),
-);
+ );
-try{
- $result = civicrm_api3('tag', 'get', $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('tag', 'get', $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 tag_get_expectedresult(){
+function tag_get_expectedresult() {
$expectedResult = array(
- 'is_error' => 0,
- 'version' => 3,
- 'count' => 1,
- 'id' => 8,
- 'values' => array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 8,
+ 'values' => array(
'8' => array(
- 'id' => '8',
- 'name' => 'New Tag3',
- ),
+ 'id' => '8',
+ 'name' => 'New Tag3',
+ ),
),
-);
+ );
return $expectedResult;
}
-
-/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetReturnArray and can be found in
+/**
+* This example has been generated from the API test suite.
+* The test that created it is called
+* testGetReturnArray
+* and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.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