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