Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
a30c801b TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * APIv3 functions for registering/processing mailing group events. | |
15 | * | |
16 | * @package CiviCRM_APIv3 | |
6a488035 TO |
17 | */ |
18 | ||
19 | /** | |
57507ae6 | 20 | * Handle a confirm event. |
6a488035 | 21 | * |
cf470720 | 22 | * @param array $params |
c28e1768 | 23 | * name/value pairs to insert in new 'survey' |
6a488035 | 24 | * |
77b97be7 | 25 | * @throws Exception |
a6c01b45 | 26 | * @return array |
72b3a70c | 27 | * api result array |
6a488035 TO |
28 | */ |
29 | function civicrm_api3_mailing_event_confirm_create($params) { | |
30 | ||
31 | $contact_id = $params['contact_id']; | |
32 | $subscribe_id = $params['subscribe_id']; | |
33 | $hash = $params['hash']; | |
34 | ||
35 | $confirm = CRM_Mailing_Event_BAO_Confirm::confirm($contact_id, $subscribe_id, $hash) !== FALSE; | |
36 | ||
37 | if (!$confirm) { | |
38 | throw new Exception('Confirmation failed'); | |
39 | } | |
40 | return civicrm_api3_create_success($params); | |
41 | } | |
11e09c59 TO |
42 | |
43 | /** | |
0965e988 EM |
44 | * Adjust Metadata for Create action. |
45 | * | |
46 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 47 | * |
cf470720 | 48 | * @param array $params |
b081365f | 49 | * Array of parameters determined by getfields. |
6a488035 TO |
50 | */ |
51 | function _civicrm_api3_mailing_event_confirm_create_spec(&$params) { | |
cf8f0fff | 52 | $params['contact_id'] = [ |
d142432b EM |
53 | 'api.required' => 1, |
54 | 'title' => 'Contact ID', | |
55 | 'type' => CRM_Utils_Type::T_INT, | |
cf8f0fff CW |
56 | ]; |
57 | $params['subscribe_id'] = [ | |
d142432b EM |
58 | 'api.required' => 1, |
59 | 'title' => 'Subscribe Event ID', | |
60 | 'type' => CRM_Utils_Type::T_INT, | |
cf8f0fff CW |
61 | ]; |
62 | $params['hash'] = [ | |
d142432b EM |
63 | 'api.required' => 1, |
64 | 'title' => 'Hash', | |
65 | 'type' => CRM_Utils_Type::T_STRING, | |
cf8f0fff | 66 | ]; |
6a488035 | 67 | } |