INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php
index 8dde90e2dc07ed569b629d8e21befc03a6f41543..ed13e1c9a015c443b5e3da7808cb357afed6752a 100644 (file)
--- a/api/v3/MailingEventQueue.php
+++ b/api/v3/MailingEventQueue.php
@@ -37,17 +37,18 @@
 /**
  * Handle a confirm event
  *
- * @param array $params Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'survey'
  *
  * @throws Exception
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields mailing_event_confirm_create}
- * @access public
  */
 function civicrm_api3_mailing_event_queue_create($params) {
   if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) {
-    throw new API_Exception("Mandatory key missing from params array: id, email_id, or phone_id field is required" );
+    throw new API_Exception("Mandatory key missing from params array: id, email_id, or phone_id field is required");
   }
   civicrm_api3_verify_mandatory($params,
     'CRM_Mailing_DAO_MailingJob',
@@ -57,10 +58,19 @@ function civicrm_api3_mailing_event_queue_create($params) {
   return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params);
 }
 
+/**
+ * @param array $params
+ * @return array
+ */
 function civicrm_api3_mailing_event_queue_get($params) {
   return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params);
 }
 
+/**
+ * @param array $params
+ * @return array
+ * @throws \API_Exception
+ */
 function civicrm_api3_mailing_event_queue_delete($params) {
   return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $params);
 }
@@ -69,7 +79,8 @@ function civicrm_api3_mailing_event_queue_delete($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_mailing_event_queue_create_spec(&$params) {
   $params['job_id']['api.required'] = 1;