api/v3/examples/MessageTemplate/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using message_template create API
   4  * *
   5  */
   6 function message_template_create_example(){
   7 $params = array(
   8   'msg_title' => 'msg_title_131',
   9   'msg_subject' => 'msg_subject_131',
  10   'msg_text' => 'msg_text_131',
  11   'msg_html' => 'msg_html_131',
  12   'workflow_id' => 131,
  13   'is_default' => '1',
  14   'is_reserved' => 1,
  15 );
  16
  17 try{
  18   $result = civicrm_api3('message_template', 'create', $params);
  19 }
  20 catch (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
  28 return $result;
  29 }
  30
  31 /**
  32  * Function returns array of result expected from previous function
  33  */
  34 function message_template_create_expectedresult(){
  35
  36   $expectedResult = array(
  37   'is_error' => 0,
  38   'version' => 3,
  39   'count' => 1,
  40   'id' => 2,
  41   'values' => array(
  42       '2' => array(
  43           'id' => '2',
  44           'msg_title' => 'msg_title_131',
  45           'msg_subject' => 'msg_subject_131',
  46           'msg_text' => 'msg_text_131',
  47           'msg_html' => 'msg_html_131',
  48           'is_active' => '1',
  49           'workflow_id' => '131',
  50           'is_default' => '1',
  51           'is_reserved' => '1',
  52           'pdf_format_id' => '',
  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 * testCreate and can be found in
  65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php
  66 *
  67 * You can see the outcome of the API tests at
  68 * https://test.civicrm.org/job/CiviCRM-master-git/
  69 *
  70 * To Learn about the API read
  71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  72 *
  73 * Browse the api on your own site with the api explorer
  74 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  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
  81 */