Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * APIv3 functions for registering/processing mailing group events. | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
6a488035 TO |
33 | */ |
34 | ||
35 | /** | |
57507ae6 | 36 | * Handle a confirm event. |
6a488035 | 37 | * |
cf470720 | 38 | * @param array $params |
c28e1768 | 39 | * name/value pairs to insert in new 'survey' |
6a488035 | 40 | * |
77b97be7 | 41 | * @throws Exception |
a6c01b45 | 42 | * @return array |
72b3a70c | 43 | * api result array |
6a488035 TO |
44 | */ |
45 | function civicrm_api3_mailing_event_confirm_create($params) { | |
46 | ||
47 | $contact_id = $params['contact_id']; | |
48 | $subscribe_id = $params['subscribe_id']; | |
49 | $hash = $params['hash']; | |
50 | ||
51 | $confirm = CRM_Mailing_Event_BAO_Confirm::confirm($contact_id, $subscribe_id, $hash) !== FALSE; | |
52 | ||
53 | if (!$confirm) { | |
54 | throw new Exception('Confirmation failed'); | |
55 | } | |
56 | return civicrm_api3_create_success($params); | |
57 | } | |
11e09c59 TO |
58 | |
59 | /** | |
0965e988 EM |
60 | * Adjust Metadata for Create action. |
61 | * | |
62 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 63 | * |
cf470720 | 64 | * @param array $params |
b081365f | 65 | * Array of parameters determined by getfields. |
6a488035 TO |
66 | */ |
67 | function _civicrm_api3_mailing_event_confirm_create_spec(&$params) { | |
d142432b EM |
68 | $params['contact_id'] = array( |
69 | 'api.required' => 1, | |
70 | 'title' => 'Contact ID', | |
71 | 'type' => CRM_Utils_Type::T_INT, | |
72 | ); | |
73 | $params['subscribe_id'] = array( | |
74 | 'api.required' => 1, | |
75 | 'title' => 'Subscribe Event ID', | |
76 | 'type' => CRM_Utils_Type::T_INT, | |
77 | ); | |
78 | $params['hash'] = array( | |
79 | 'api.required' => 1, | |
80 | 'title' => 'Hash', | |
81 | 'type' => CRM_Utils_Type::T_STRING, | |
82 | ); | |
6a488035 | 83 | } |