X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMessageTemplate.php;h=b2ca5e145a8b5214581a586fa7b792cf0caf147b;hb=8319cf114f26e04bb7586cd253af9d97b8cb3859;hp=6bd144b6e9b08407be91daa5f1dbf5081ecd5faa;hpb=fa2afd74506815d24940f93f47d748c016fc3224;p=civicrm-core.git diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index 6bd144b6e9..b2ca5e145a 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -22,7 +22,7 @@ | 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 @@ -32,7 +32,9 @@ */ /** - * @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); @@ -51,16 +53,14 @@ function _civicrm_api3_message_template_create_spec(&$params) { /* $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); @@ -75,18 +75,11 @@ 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); @@ -94,6 +87,7 @@ function civicrm_api3_message_template_get($params) { /** * Sends a template. + * @param array $params */ function civicrm_api3_message_template_send($params) { CRM_Core_BAO_MessageTemplates::sendTemplate($params);