Commit | Line | Data |
---|---|---|
425723d9 | 1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
425723d9 | 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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
425723d9 | 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$ | |
425723d9 | 35 | */ |
5c766a0b | 36 | |
425723d9 | 37 | /** |
2e66abf8 | 38 | * Handle a confirm event. |
425723d9 | 39 | * |
cf470720 | 40 | * @param array $params |
2e66abf8 | 41 | * Array of property. |
425723d9 | 42 | * |
43 | * @throws Exception | |
a6c01b45 | 44 | * @return array |
72b3a70c | 45 | * api result array |
425723d9 | 46 | */ |
47 | function civicrm_api3_mailing_event_queue_create($params) { | |
bd6658bd | 48 | if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) { |
481a74f4 | 49 | throw new API_Exception("Mandatory key missing from params array: id, email_id, or phone_id field is required"); |
425723d9 | 50 | } |
51 | civicrm_api3_verify_mandatory($params, | |
52 | 'CRM_Mailing_DAO_MailingJob', | |
868e247d | 53 | array('job_id', 'contact_id'), |
425723d9 | 54 | FALSE |
55 | ); | |
bd6658bd | 56 | return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params); |
425723d9 | 57 | } |
bd6658bd | 58 | |
c23f45d3 | 59 | /** |
2e66abf8 EM |
60 | * Get mailing event queue record. |
61 | * | |
c23f45d3 | 62 | * @param array $params |
dc64d047 | 63 | * |
c23f45d3 EM |
64 | * @return array |
65 | */ | |
425723d9 | 66 | function civicrm_api3_mailing_event_queue_get($params) { |
67 | return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params); | |
68 | } | |
bd6658bd | 69 | |
c23f45d3 | 70 | /** |
2e66abf8 EM |
71 | * Delete mailing event queue record. |
72 | * | |
c23f45d3 | 73 | * @param array $params |
2e66abf8 | 74 | * |
c23f45d3 EM |
75 | * @return array |
76 | * @throws \API_Exception | |
77 | */ | |
bd6658bd TO |
78 | function civicrm_api3_mailing_event_queue_delete($params) { |
79 | return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $params); | |
80 | } | |
81 | ||
425723d9 | 82 | /** |
0aa0303c EM |
83 | * Adjust Metadata for Create action. |
84 | * | |
85 | * The metadata is used for setting defaults, documentation & validation. | |
425723d9 | 86 | * |
cf470720 TO |
87 | * @param array $params |
88 | * Array or parameters determined by getfields. | |
425723d9 | 89 | */ |
90 | function _civicrm_api3_mailing_event_queue_create_spec(&$params) { | |
91 | $params['job_id']['api.required'] = 1; | |
92 | $params['contact_id']['api.required'] = 1; | |
93 | } |