Commit | Line | Data |
---|---|---|
6a488035 | 1 | {literal}<?php{/literal} |
947a37b4 | 2 | /** |
3 | * Test Generated example of using {$fnPrefix} {$action} API | |
e6ff1593 | 4 | *{if $description} {$description}{/if} |
947a37b4 | 5 | * |
6a488035 TO |
6 | */ |
7 | function {$function}_example(){literal}{{/literal} | |
8 | $params = {$params|@print_array}; | |
947a37b4 | 9 | {literal} |
10 | try{{/literal} | |
11 | $result = civicrm_api3('{$fnPrefix}', '{$action}', $params); | |
12 | {literal}} | |
13 | catch (CiviCRM_API3_Exception $e) { | |
14 | // handle error here | |
15 | $errorMessage = $e->getMessage(); | |
16 | $errorCode = $e->getErrorCode(); | |
17 | $errorData = $e->getExtraParams(); | |
18 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
19 | }{/literal} | |
20 | ||
21 | return $result; | |
6a488035 TO |
22 | {literal}}{/literal} |
23 | ||
947a37b4 | 24 | /** |
6a488035 TO |
25 | * Function returns array of result expected from previous function |
26 | */ | |
27 | function {$function}_expectedresult(){literal}{{/literal} | |
28 | ||
29 | $expectedResult = {$result|@print_array}; | |
30 | ||
947a37b4 | 31 | return $expectedResult; |
6a488035 TO |
32 | {literal}}{/literal} |
33 | ||
34 | ||
35 | /* | |
36 | * This example has been generated from the API test suite. The test that created it is called | |
37 | * | |
38 | * {$testfunction} and can be found in | |
3ec6e38d | 39 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$filename} |
6a488035 TO |
40 | * |
41 | * You can see the outcome of the API tests at | |
3ec6e38d | 42 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
43 | * |
44 | * To Learn about the API read | |
3ec6e38d | 45 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 46 | * |
3ec6e38d CW |
47 | * Browse the api on your own site with the api explorer |
48 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
49 | * |
50 | * Read more about testing here | |
51 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
52 | * | |
53 | * API Standards documentation: | |
54 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
fb32de45 | 55 | */ |