Commit | Line | Data |
---|---|---|
397e0e51 | 1 | <?php |
50fb255d | 2 | /** |
3 | * Test Generated example of using message_template get API. | |
4 | * | |
5 | * | |
6 | * @return array | |
7 | * API result array | |
8 | */ | |
9 | function message_template_get_example() { | |
10 | $params = array( | |
11 | 'msg_title' => 'msg_title_166', | |
12 | 'msg_subject' => 'msg_subject_166', | |
13 | 'msg_text' => 'msg_text_166', | |
14 | 'msg_html' => 'msg_html_166', | |
15 | 'workflow_id' => 166, | |
16 | 'is_default' => '1', | |
17 | 'is_reserved' => 1, | |
18 | ); | |
397e0e51 | 19 | |
50fb255d | 20 | try{ |
21 | $result = civicrm_api3('message_template', 'get', $params); | |
22 | } | |
23 | catch (CiviCRM_API3_Exception $e) { | |
24 | // Handle error here. | |
25 | $errorMessage = $e->getMessage(); | |
26 | $errorCode = $e->getErrorCode(); | |
27 | $errorData = $e->getExtraParams(); | |
28 | return array( | |
29 | 'error' => $errorMessage, | |
30 | 'error_code' => $errorCode, | |
31 | 'error_data' => $errorData, | |
32 | ); | |
33 | } | |
34 | ||
35 | return $result; | |
397e0e51 EC |
36 | } |
37 | ||
38 | /** | |
50fb255d | 39 | * Function returns array of result expected from previous function. |
40 | * | |
41 | * @return array | |
42 | * API result array | |
397e0e51 | 43 | */ |
50fb255d | 44 | function message_template_get_expectedresult() { |
397e0e51 EC |
45 | |
46 | $expectedResult = array( | |
50fb255d | 47 | 'is_error' => 0, |
48 | 'version' => 3, | |
49 | 'count' => 1, | |
50 | 'id' => 66, | |
51 | 'values' => array( | |
52 | '66' => array( | |
53 | 'id' => '66', | |
54 | 'msg_title' => 'msg_title_166', | |
55 | 'msg_subject' => 'msg_subject_166', | |
56 | 'msg_text' => 'msg_text_166', | |
57 | 'msg_html' => 'msg_html_166', | |
58 | 'is_active' => '1', | |
59 | 'workflow_id' => '166', | |
60 | 'is_default' => '1', | |
61 | 'is_reserved' => '1', | |
62 | 'is_sms' => '1', | |
63 | 'pdf_format_id' => '166', | |
64 | ), | |
397e0e51 | 65 | ), |
50fb255d | 66 | ); |
397e0e51 EC |
67 | |
68 | return $expectedResult; | |
69 | } | |
70 | ||
50fb255d | 71 | /** |
72 | * This example has been generated from the API test suite. | |
73 | * The test that created it is called | |
74 | * testGet | |
75 | * and can be found in | |
69d79249 | 76 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php |
397e0e51 EC |
77 | * |
78 | * You can see the outcome of the API tests at | |
69d79249 | 79 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
397e0e51 EC |
80 | * |
81 | * To Learn about the API read | |
69d79249 | 82 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
397e0e51 | 83 | * |
69d79249 | 84 | * Browse the api on your own site with the api explorer |
41d4d31f | 85 | * http://MYSITE.ORG/path/to/civicrm/api |
397e0e51 EC |
86 | * |
87 | * Read more about testing here | |
88 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
89 | * | |
90 | * API Standards documentation: | |
91 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 92 | */ |