INFRA-132 - Fix comment spacing
[civicrm-core.git] / api / v3 / MailingEventQueue.php
index acfc28d58c9982a2d73c086dffdca3b8b0523963..d2d03032f7d9b453ee1d9579de7cd4d000c073a4 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -37,7 +37,8 @@
 /**
  * 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
  * @access public
  */
 function civicrm_api3_mailing_event_queue_create($params) {
-  if (!array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) {
-    throw new API_Exception("Mandatory key(s) missing from params array: email_id or phone_id field are required" );
+  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");
   }
   civicrm_api3_verify_mandatory($params,
     'CRM_Mailing_DAO_MailingJob',
     array('job_id','contact_id'),
     FALSE
   );
-  $mailingEventQueueArray = array();
-  $mailingEventQueueBAO = CRM_Mailing_Event_BAO_Queue::create($params);
-  _civicrm_api3_object_to_array($mailingEventQueueBAO, $mailingEventQueueArray[$mailingEventQueueBAO->id]);
-  return civicrm_api3_create_success($mailingEventQueueArray);
+  return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params);
 }
+
 function civicrm_api3_mailing_event_queue_get($params) {
   return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params);
 }
+
+function civicrm_api3_mailing_event_queue_delete($params) {
+  return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $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;