api/v3/examples/MessageTemplate/Get.php

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