| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | Copyright CiviCRM LLC. All rights reserved. | |
| 5 | | | |
| 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 | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * |
| 14 | * APIv3 functions for registering/processing mailing group events. |
| 15 | * |
| 16 | * @package CiviCRM_APIv3 |
| 17 | */ |
| 18 | |
| 19 | /** |
| 20 | * Subscribe from mailing group. |
| 21 | * |
| 22 | * @param array $params |
| 23 | * Array per getfields metadata. |
| 24 | * |
| 25 | * @throws API_Exception |
| 26 | * @return array |
| 27 | * api result array |
| 28 | */ |
| 29 | function civicrm_api3_mailing_event_subscribe_create($params) { |
| 30 | $email = $params['email']; |
| 31 | $group_id = $params['group_id']; |
| 32 | $contact_id = CRM_Utils_Array::value('contact_id', $params); |
| 33 | |
| 34 | $group = new CRM_Contact_DAO_Group(); |
| 35 | $group->is_active = 1; |
| 36 | $group->id = (int) $group_id; |
| 37 | if (!$group->find(TRUE)) { |
| 38 | throw new API_Exception('Invalid Group id'); |
| 39 | } |
| 40 | |
| 41 | $subscribe = CRM_Mailing_Event_BAO_Subscribe::subscribe($group_id, $email, $contact_id); |
| 42 | |
| 43 | if ($subscribe !== NULL) { |
| 44 | /* Ask the contact for confirmation */ |
| 45 | |
| 46 | $subscribe->send_confirm_request($email); |
| 47 | |
| 48 | $values = []; |
| 49 | $values[$subscribe->id]['contact_id'] = $subscribe->contact_id; |
| 50 | $values[$subscribe->id]['subscribe_id'] = $subscribe->id; |
| 51 | $values[$subscribe->id]['hash'] = $subscribe->hash; |
| 52 | |
| 53 | return civicrm_api3_create_success($values); |
| 54 | } |
| 55 | return civicrm_api3_create_error('Subscription failed'); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Adjust Metadata for Create action. |
| 60 | * |
| 61 | * The metadata is used for setting defaults, documentation & validation. |
| 62 | * |
| 63 | * @param array $params |
| 64 | * Array of parameters determined by getfields. |
| 65 | */ |
| 66 | function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) { |
| 67 | $params['email'] = [ |
| 68 | 'api.required' => 1, |
| 69 | 'title' => 'Unsubscribe Email', |
| 70 | 'type' => CRM_Utils_Type::T_STRING, |
| 71 | ]; |
| 72 | $params['group_id'] = [ |
| 73 | 'api.required' => 1, |
| 74 | 'title' => 'Unsubscribe From Group', |
| 75 | 'type' => CRM_Utils_Type::T_INT, |
| 76 | ]; |
| 77 | } |