api/v3/MailingEventQueue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27 /**
  28  *
  29  * APIv3 functions for registering/processing mailing group events.
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_MailerGroup
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  * $Id$
  35  *
  36  */
  37 /**
  38  * Handle a confirm event
  39  *
  40  * @param array $params Associative array of property
  41  *                       name/value pairs to insert in new 'survey'
  42  *
  43  * @throws Exception
  44  * @return array api result array
  45  * {@getfields mailing_event_confirm_create}
  46  * @access public
  47  */
  48 function civicrm_api3_mailing_event_queue_create($params) {
  49   if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) {
  50     throw new API_Exception("Mandatory key missing from params array: id, email_id, or phone_id field is required" );
  51   }
  52   civicrm_api3_verify_mandatory($params,
  53     'CRM_Mailing_DAO_MailingJob',
  54     array('job_id','contact_id'),
  55     FALSE
  56   );
  57   return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params);
  58 }
  59
  60 function civicrm_api3_mailing_event_queue_get($params) {
  61   return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params);
  62 }
  63
  64 function civicrm_api3_mailing_event_queue_delete($params) {
  65   return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $params);
  66 }
  67
  68 /**
  69  * Adjust Metadata for Create action
  70  *
  71  * The metadata is used for setting defaults, documentation & validation
  72  * @param array $params array or parameters determined by getfields
  73  */
  74 function _civicrm_api3_mailing_event_queue_create_spec(&$params) {
  75   $params['job_id']['api.required'] = 1;
  76   $params['contact_id']['api.required'] = 1;
  77 }