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 boolean
  63  *   | error  true if successfull, error otherwise
  64  * {@getfields message_template_delete}
  65  */
  66 function civicrm_api3_message_template_delete($params) {
  67   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  68 }
  69
  70 /**
  71  * @param array $params
  72  */
  73 function _civicrm_api3_message_template_get_spec(&$params) {
  74 }
  75
  76 /**
  77  * Retrieve one or more message_template
  78  *
  79  * @param array $params
  80  *   An associative array of name/value pairs.
  81  *
  82  * @return array
  83  *   api result array
  84  */
  85 function civicrm_api3_message_template_get($params) {
  86   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }
  88
  89 /**
  90  * Sends a template.
  91  * @param array $params
  92  */
  93 function civicrm_api3_message_template_send($params) {
  94   CRM_Core_BAO_MessageTemplates::sendTemplate($params);
  95 }
  96
  97 /**
  98  * Adjust Metadata for Create action
  99  *
 100  * The metadata is used for setting defaults, documentation &
 101  * validation.
 102  *
 103  * @param array $params
 104  *   Array or parameters determined by getfields.
 105  */
 106 function _civicrm_api3_message_template_send_spec(&$params) {
 107   $params['messageTemplateID']['api.required'] = 1;
 108   $params['messageTemplateID']['title'] = 'Message Template ID';
 109   $params['contactId']['api.required'] = 1;
 110   $params['contactId']['title'] = 'Contact ID';
 111   $params['toEmail']['api.required'] = 1;
 112   $params['toEmail']['title'] = 'To Email';
 113   $params['toName']['api.required'] = 1;
 114   $params['toName']['title'] = 'To Name';
 115 }