INFRA-132 - api - Convert single-line @param to multi-line

[civicrm-core.git] / api / v3 / MessageTemplate.php

<?php
// $Id$
/*
 +--------------------------------------------------------------------+
 | Project60 version 4.3                                              |
 +--------------------------------------------------------------------+
 | Copyright TTTP (c) 2004-2013                                       |
 +--------------------------------------------------------------------+
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | 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
 *
 * @package CiviCRM_SEPA
 *
 */

/**
 * @access public
 */
function civicrm_api3_message_template_create($params) {
  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Adjust Metadata for Create action
 *
 * The metadata is used for setting defaults, documentation & validation
 * @param array $params
 *   Array or parameters determined by getfields.
 */
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['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
 */
function civicrm_api3_message_template_delete($params) {
  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * @param array $params
 */
function _civicrm_api3_message_template_get_spec(&$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
 */
function civicrm_api3_message_template_get($params) {
  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Sends a template.
 */
function civicrm_api3_message_template_send($params) {
  CRM_Core_BAO_MessageTemplates::sendTemplate($params);
}

/**
 * Adjust Metadata for Create action
 *
 * The metadata is used for setting defaults, documentation &
 * validation.
 *
 * @param array $params
 *   Array or parameters determined by getfields.
 */
function _civicrm_api3_message_template_send_spec(&$params) {
  $params['messageTemplateID']['api.required'] = 1;
  $params['messageTemplateID']['title'] = 'Message Template ID';
  $params['contactId']['api.required'] = 1;
  $params['contactId']['title'] = 'Contact ID';
  $params['toEmail']['api.required'] = 1;
  $params['toEmail']['title'] = 'To Email';
  $params['toName']['api.required'] = 1;
  $params['toName']['title'] = 'To Name';
}