1 {literal}<?php{/literal}
3 * Test Generated example demonstrating the {$entity}.{$action} API.
5 {if !empty($result.deprecated) && is_string($result.deprecated)}
13 {foreach from=$description item='line'}
21 function {$function}_example() {literal}{{/literal}
22 $params = {$params|@print_array};
25 $result = civicrm_api3('{$entity}', '{$action}', $params);
27 catch (CiviCRM_API3_Exception $e) {
29 $errorMessage = $e->getMessage();
30 $errorCode = $e->getErrorCode();
31 $errorData = $e->getExtraParams();
34 'error_message' => $errorMessage,
35 'error_code' => $errorCode,
36 'error_data' => $errorData,
44 * Function returns array of result expected from previous function.
49 function {$function}_expectedresult() {literal}{{/literal}
51 $expectedResult = {$result|@print_array};
53 return $expectedResult;
57 * This example has been generated from the API test suite.
58 * The test that created it is called "{$testFunction}"
59 * and can be found at:
60 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$testFile}
62 * You can see the outcome of the API tests at
63 * https://test.civicrm.org/job/CiviCRM-master-git/
65 * To Learn about the API read
66 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
68 * Browse the api on your own site with the api explorer
69 * http://MYSITE.ORG/path/to/civicrm/api
71 * Read more about testing here
72 * http://wiki.civicrm.org/confluence/display/CRM/Testing
74 * API Standards documentation:
75 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards