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 = array(
  10     'msg_title' => 'msg_title_166',
  11     'msg_subject' => 'msg_subject_166',
  12     'msg_text' => 'msg_text_166',
  13     'msg_html' => 'msg_html_166',
  14     'workflow_id' => 166,
  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 array(
  28       'error' => $errorMessage,
  29       'error_code' => $errorCode,
  30       'error_data' => $errorData,
  31     );
  32   }
  33
  34   return $result;
  35 }
  36
  37 /**
  38  * Function returns array of result expected from previous function.
  39  *
  40  * @return array
  41  *   API result array
  42  */
  43 function message_template_get_expectedresult() {
  44
  45   $expectedResult = array(
  46     'is_error' => 0,
  47     'version' => 3,
  48     'count' => 1,
  49     'id' => 68,
  50     'values' => array(
  51       '68' => array(
  52         'id' => '68',
  53         'msg_title' => 'msg_title_166',
  54         'msg_subject' => 'msg_subject_166',
  55         'msg_text' => 'msg_text_166',
  56         'msg_html' => 'msg_html_166',
  57         'is_active' => '1',
  58         'workflow_id' => '166',
  59         'is_default' => '1',
  60         'is_reserved' => '1',
  61         'is_sms' => '1',
  62         'pdf_format_id' => '166',
  63       ),
  64     ),
  65   );
  66
  67   return $expectedResult;
  68 }
  69
  70 /*
  71 * This example has been generated from the API test suite.
  72 * The test that created it is called "testGet"
  73 * and can be found at:
  74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/MessageTemplateTest.php
  75 *
  76 * You can see the outcome of the API tests at
  77 * https://test.civicrm.org/job/CiviCRM-master-git/
  78 *
  79 * To Learn about the API read
  80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  81 *
  82 * Browse the api on your own site with the api explorer
  83 * http://MYSITE.ORG/path/to/civicrm/api
  84 *
  85 * Read more about testing here
  86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  87 *
  88 * API Standards documentation:
  89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  90 */