Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
6a488035 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * | |
31 | * APIv3 functions for registering/processing mailing group events. | |
32 | * | |
33 | * @package CiviCRM_APIv3 | |
34 | * @subpackage API_MailerGroup | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * $Id$ |
37 | * | |
38 | */ | |
39 | ||
40 | /** | |
41 | * Subscribe from mailing group | |
42 | * | |
77b97be7 | 43 | * @param array $params Associative array of property |
6a488035 TO |
44 | * name/value pairs to insert in new 'survey' |
45 | * | |
77b97be7 | 46 | * @throws API_Exception |
6a488035 TO |
47 | * @return array api result array |
48 | * {@getfields mailing_event_subscribe_create} | |
49 | * @access public | |
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; | |
58 | $group->id = (int)$group_id; | |
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 | ||
68 | ||
69 | $subscribe->send_confirm_request($email); | |
70 | ||
71 | $values = array(); | |
9e23eadb | 72 | $values[$subscribe->id]['contact_id'] = $subscribe->contact_id; |
73 | $values[$subscribe->id]['subscribe_id'] = $subscribe->id; | |
74 | $values[$subscribe->id]['hash'] = $subscribe->hash; | |
6a488035 TO |
75 | |
76 | return civicrm_api3_create_success($values); | |
77 | } | |
78 | return civicrm_api3_create_error('Subscription failed'); | |
79 | } | |
11e09c59 TO |
80 | |
81 | /** | |
6a488035 | 82 | * Adjust Metadata for Create action |
1c88e578 | 83 | * |
6a488035 TO |
84 | * The metadata is used for setting defaults, documentation & validation |
85 | * @param array $params array or parameters determined by getfields | |
86 | */ | |
87 | function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) { | |
88 | $params['email']['api.required'] = 1; | |
89 | $params['group_id']['api.required'] = 1; | |
90 | } | |
91 |