X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMessageTemplate.php;h=b2ca5e145a8b5214581a586fa7b792cf0caf147b;hb=8319cf114f26e04bb7586cd253af9d97b8cb3859;hp=809db8fcbe79e444557ce3131e83f4b1159ff367;hpb=8f6ae60501d5d64ddbc6269648e71247dee0ce1b;p=civicrm-core.git

diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php
index 809db8fcbe..b2ca5e145a 100644
--- a/api/v3/MessageTemplate.php
+++ b/api/v3/MessageTemplate.php
@@ -1,5 +1,4 @@
 <?php
-// $Id$
 /*
  +--------------------------------------------------------------------+
  | Project60 version 4.3                                              |
@@ -23,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
@@ -33,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);
@@ -43,30 +44,30 @@ function civicrm_api3_message_template_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @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['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
+ * @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);
 }
 
 /**
- * @param $params
+ * @param array $params
  */
 function _civicrm_api3_message_template_get_spec(&$params) {
 }
@@ -74,16 +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.
+ * @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);
@@ -91,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);
@@ -102,16 +99,16 @@ function civicrm_api3_message_template_send($params) {
  * The metadata is used for setting defaults, documentation &
  * validation.
  *
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_message_template_send_spec(&$params) {
-  $required = array(
-    'messageTemplateID',
-    'contactId',
-    'toEmail',
-    'toName',
-  );
-  foreach ($required as $value) {
-    $params[$value]['api.required'] = 1;
-  }
+  $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';
 }