Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | |
33 | * @subpackage API_MailerGroup | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | ||
39 | /** | |
40 | * Subscribe from mailing group | |
41 | * | |
cf470720 TO |
42 | * @param array $params |
43 | * Associative array of property. | |
6a488035 TO |
44 | * name/value pairs to insert in new 'survey' |
45 | * | |
77b97be7 | 46 | * @throws API_Exception |
a6c01b45 | 47 | * @return array |
72b3a70c | 48 | * api result array |
28a04ea9 | 49 | * {@getfields mailing_event_subscribe_create} |
6a488035 TO |
50 | */ |
51 | function civicrm_api3_mailing_event_subscribe_create($params) { | |
52 | $email = $params['email']; | |
53 | $group_id = $params['group_id']; | |
54 | $contact_id = CRM_Utils_Array::value('contact_id', $params); | |
55 | ||
56 | $group = new CRM_Contact_DAO_Group(); | |
57 | $group->is_active = 1; | |
28a04ea9 | 58 | $group->id = (int) $group_id; |
6a488035 | 59 | if (!$group->find(TRUE)) { |
9e23eadb | 60 | throw new API_Exception('Invalid Group id'); |
6a488035 TO |
61 | } |
62 | ||
63 | $subscribe = CRM_Mailing_Event_BAO_Subscribe::subscribe($group_id, $email, $contact_id); | |
64 | ||
65 | if ($subscribe !== NULL) { | |
66 | /* Ask the contact for confirmation */ | |
67 | ||
6a488035 TO |
68 | $subscribe->send_confirm_request($email); |
69 | ||
70 | $values = array(); | |
9e23eadb | 71 | $values[$subscribe->id]['contact_id'] = $subscribe->contact_id; |
72 | $values[$subscribe->id]['subscribe_id'] = $subscribe->id; | |
73 | $values[$subscribe->id]['hash'] = $subscribe->hash; | |
6a488035 TO |
74 | |
75 | return civicrm_api3_create_success($values); | |
76 | } | |
77 | return civicrm_api3_create_error('Subscription failed'); | |
78 | } | |
11e09c59 TO |
79 | |
80 | /** | |
0aa0303c EM |
81 | * Adjust Metadata for Create action. |
82 | * | |
83 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 84 | * |
cf470720 TO |
85 | * @param array $params |
86 | * Array or parameters determined by getfields. | |
6a488035 TO |
87 | */ |
88 | function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) { | |
89 | $params['email']['api.required'] = 1; | |
a6aeb992 | 90 | $params['email']['title'] = 'Unsubscribe Email'; |
6a488035 | 91 | $params['group_id']['api.required'] = 1; |
a6aeb992 | 92 | $params['group_id']['title'] = 'Unsubscribe From Group'; |
6a488035 | 93 | } |