Merge branch 'master' of https://github.com/civicrm/civicrm-core into labels
[civicrm-core.git] / api / v3 / examples / MessageTemplatesCreate.php
CommitLineData
397e0e51
EC
1<?php
2/**
3 * Test Generated example of using message_templates create API
4 * *
5 */
6function message_templates_create_example(){
7$params = array(
8 'msg_title' => 'msg_title_1',
9 'msg_subject' => 'msg_subject_1',
10 'msg_text' => 'msg_text_1',
11 'msg_html' => 'msg_html_1',
12 'workflow_id' => 1,
13 'is_default' => '',
14 'is_reserved' => 1,
15 'pdf_format_id' => '1',
16);
17
18try{
19 $result = civicrm_api3('message_templates', 'create', $params);
20}
21catch (CiviCRM_API3_Exception $e) {
22 // handle error here
23 $errorMessage = $e->getMessage();
24 $errorCode = $e->getErrorCode();
25 $errorData = $e->getExtraParams();
26 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
27}
28
29return $result;
30}
31
32/**
33 * Function returns array of result expected from previous function
34 */
35function message_templates_create_expectedresult(){
36
37 $expectedResult = array(
38 'is_error' => 0,
39 'version' => 3,
40 'count' => 1,
41 'id' => 2,
42 'values' => array(
43 '2' => array(
44 'id' => '2',
45 'msg_title' => 'msg_title_1',
46 'msg_subject' => 'msg_subject_1',
47 'msg_text' => 'msg_text_1',
48 'msg_html' => 'msg_html_1',
49 'is_active' => '1',
50 'workflow_id' => '1',
51 'is_default' => '',
52 'is_reserved' => '1',
53 'pdf_format_id' => '1',
54 ),
55 ),
56);
57
58 return $expectedResult;
59}
60
61
62/*
63* This example has been generated from the API test suite. The test that created it is called
64*
65* testCreate and can be found in
66* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/MessageTemplatesTest.php
67*
68* You can see the outcome of the API tests at
69* http://tests.dev.civicrm.org/trunk/results-api_v3
70*
71* To Learn about the API read
72* http://book.civicrm.org/developer/current/techniques/api/
73*
74* and review the wiki at
75* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
76*
77* Read more about testing here
78* http://wiki.civicrm.org/confluence/display/CRM/Testing
79*
80* API Standards documentation:
81* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
82*/