1 {literal}<?php{/literal}
4 * Test Generated API Example.
5 * See bottom of this file for more detail.
9 * Test Generated example of using {$fnPrefix} {$action} API.
18 function {$function}_example() {literal}{{/literal}
19 $params = {$params|@print_array};
22 $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
24 catch (CiviCRM_API3_Exception $e) {
26 $errorMessage = $e->getMessage();
27 $errorCode = $e->getErrorCode();
28 $errorData = $e->getExtraParams();
30 'error' => $errorMessage,
31 'error_code' => $errorCode,
32 'error_data' => $errorData,
40 * Function returns array of result expected from previous function.
45 function {$function}_expectedresult() {literal}{{/literal}
47 $expectedResult = {$result|@print_array};
49 return $expectedResult;
53 * This example has been generated from the API test suite.
54 * The test that created it is called
57 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$filename}
59 * You can see the outcome of the API tests at
60 * https://test.civicrm.org/job/CiviCRM-master-git/
62 * To Learn about the API read
63 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
65 * Browse the api on your own site with the api explorer
66 * http://MYSITE.ORG/path/to/civicrm/api/explorer
68 * Read more about testing here
69 * http://wiki.civicrm.org/confluence/display/CRM/Testing
71 * API Standards documentation:
72 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards