api/v3/MessageTemplate.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Project60 version 4.3                                              |
   5  +--------------------------------------------------------------------+
   6  | Copyright TTTP (c) 2004-2013                                       |
   7  +--------------------------------------------------------------------+
   8  |                                                                    |
   9  | CiviCRM is free software; you can copy, modify, and distribute it  |
  10  | under the terms of the GNU Affero General Public License           |
  11  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  12  |                                                                    |
  13  | CiviCRM is distributed in the hope that it will be useful, but     |
  14  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  16  | See the GNU Affero General Public License for more details.        |
  17  |                                                                    |
  18  | You should have received a copy of the GNU Affero General Public   |
  19  | License and the CiviCRM Licensing Exception along                  |
  20  | with this program; if not, contact CiviCRM LLC                     |
  21  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  22  | GNU Affero General Public License or the licensing of CiviCRM,     |
  23  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  24  +--------------------------------------------------------------------+
  25 */
  26
  27 /**
  28  * File for the CiviCRM APIv3 message_template functions
  29  *
  30  * @package CiviCRM_SEPA
  31  *
  32  */
  33
  34 /**
  35  * @param array $params
  36  * @return array
  37  * @throws \API_Exception
  38  */
  39 function civicrm_api3_message_template_create($params) {
  40   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  41 }
  42
  43 /**
  44  * Adjust Metadata for Create action
  45  *
  46  * The metadata is used for setting defaults, documentation & validation
  47  * @param array $params
  48  *   Array or parameters determined by getfields.
  49  */
  50 function _civicrm_api3_message_template_create_spec(&$params) {
  51   $params['msg_title']['api.required'] = 1;
  52   $params['is_active']['api.default'] = TRUE;
  53   /*  $params['entity_id']['api.required'] = 1;
  54   $params['entity_table']['api.default'] = "civicrm_contribution_recur";
  55   $params['type']['api.default'] = "R";
  56   */
  57 }
  58
  59 /**
  60  * @param array $params
  61  *
  62  * @return bool
  63  *   API result array
  64  */
  65 function civicrm_api3_message_template_delete($params) {
  66   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  67 }
  68
  69 /**
  70  * @param array $params
  71  */
  72 function _civicrm_api3_message_template_get_spec(&$params) {
  73 }
  74
  75 /**
  76  * Retrieve one or more message_template
  77  *
  78  * @param array $params
  79  *   An associative array of name/value pairs.
  80  *
  81  * @return array
  82  *   api result array
  83  */
  84 function civicrm_api3_message_template_get($params) {
  85   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  86 }
  87
  88 /**
  89  * Sends a template.
  90  * @param array $params
  91  */
  92 function civicrm_api3_message_template_send($params) {
  93   CRM_Core_BAO_MessageTemplates::sendTemplate($params);
  94 }
  95
  96 /**
  97  * Adjust Metadata for Create action
  98  *
  99  * The metadata is used for setting defaults, documentation &
 100  * validation.
 101  *
 102  * @param array $params
 103  *   Array or parameters determined by getfields.
 104  */
 105 function _civicrm_api3_message_template_send_spec(&$params) {
 106   $params['messageTemplateID']['api.required'] = 1;
 107   $params['messageTemplateID']['title'] = 'Message Template ID';
 108   $params['contactId']['api.required'] = 1;
 109   $params['contactId']['title'] = 'Contact ID';
 110   $params['toEmail']['api.required'] = 1;
 111   $params['toEmail']['title'] = 'To Email';
 112   $params['toName']['api.required'] = 1;
 113   $params['toName']['title'] = 'To Name';
 114 }