<?php
-// $Id$
/*
+--------------------------------------------------------------------+
| Project60 version 4.3 |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* File for the CiviCRM APIv3 message_template functions
*/
/**
- * @access public
+ * @param array $params
+ * @return array
+ * @throws \API_Exception
*/
function civicrm_api3_message_template_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*/
function _civicrm_api3_message_template_create_spec(&$params) {
$params['msg_title']['api.required'] = 1;
- $params['is_active']['api.default'] = true;
-/* $params['entity_id']['api.required'] = 1;
+ $params['is_active']['api.default'] = TRUE;
+ /* $params['entity_id']['api.required'] = 1;
$params['entity_table']['api.default'] = "civicrm_contribution_recur";
$params['type']['api.default'] = "R";
-*/
+ */
}
/**
* @param array $params
*
- * @return boolean | error true if successfull, error otherwise
- * {@getfields message_template_delete}
- * @access public
+ * @return bool
+ * API result array
*/
function civicrm_api3_message_template_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* Retrieve one or more message_template
*
- * @param array input parameters
- *
- *
- * @example SepaCreditorGet.php Standard Get Example
- *
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
- * {@getfields message_template_get}
- * @access public
+ * @return array
+ * api result array
*/
function civicrm_api3_message_template_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* Sends a template.
+ * @param array $params
*/
function civicrm_api3_message_template_send($params) {
CRM_Core_BAO_MessageTemplates::sendTemplate($params);