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 | +--------------------------------------------------------------------+ | |
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 | * | |
cf470720 TO |
40 | * @param array $params |
41 | * Associative array of property. | |
425723d9 | 42 | * name/value pairs to insert in new 'survey' |
43 | * | |
44 | * @throws Exception | |
a6c01b45 | 45 | * @return array |
72b3a70c | 46 | * api result array |
425723d9 | 47 | * {@getfields mailing_event_confirm_create} |
425723d9 | 48 | */ |
49 | function civicrm_api3_mailing_event_queue_create($params) { | |
bd6658bd | 50 | if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) { |
481a74f4 | 51 | throw new API_Exception("Mandatory key missing from params array: id, email_id, or phone_id field is required"); |
425723d9 | 52 | } |
53 | civicrm_api3_verify_mandatory($params, | |
54 | 'CRM_Mailing_DAO_MailingJob', | |
55 | array('job_id','contact_id'), | |
56 | FALSE | |
57 | ); | |
bd6658bd | 58 | return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params); |
425723d9 | 59 | } |
bd6658bd | 60 | |
c23f45d3 EM |
61 | /** |
62 | * @param array $params | |
63 | * @return array | |
64 | */ | |
425723d9 | 65 | function civicrm_api3_mailing_event_queue_get($params) { |
66 | return _civicrm_api3_basic_get('CRM_Mailing_Event_BAO_Queue', $params); | |
67 | } | |
bd6658bd | 68 | |
c23f45d3 EM |
69 | /** |
70 | * @param array $params | |
71 | * @return array | |
72 | * @throws \API_Exception | |
73 | */ | |
bd6658bd TO |
74 | function civicrm_api3_mailing_event_queue_delete($params) { |
75 | return _civicrm_api3_basic_delete('CRM_Mailing_Event_BAO_Queue', $params); | |
76 | } | |
77 | ||
425723d9 | 78 | /** |
79 | * Adjust Metadata for Create action | |
80 | * | |
81 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
82 | * @param array $params |
83 | * Array or parameters determined by getfields. | |
425723d9 | 84 | */ |
85 | function _civicrm_api3_mailing_event_queue_create_spec(&$params) { | |
86 | $params['job_id']['api.required'] = 1; | |
87 | $params['contact_id']['api.required'] = 1; | |
88 | } |