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