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