api/v3/MailingEventSubscribe.php

   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 = $params['contact_id'] ?? NULL;
  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   if (substr($group->visibility, 0, 6) != 'Public') {
  42     throw new API_Exception('Group is not Public. Contact cannot be subscribed to this Group.');
  43   }
  44
  45   $subscribe = CRM_Mailing_Event_BAO_Subscribe::subscribe($group_id, $email, $contact_id);
  46
  47   if ($subscribe !== NULL) {
  48     /* Ask the contact for confirmation */
  49
  50     $subscribe->send_confirm_request($email);
  51
  52     $values = [];
  53     $values[$subscribe->id]['contact_id'] = $subscribe->contact_id;
  54     $values[$subscribe->id]['subscribe_id'] = $subscribe->id;
  55     $values[$subscribe->id]['hash'] = $subscribe->hash;
  56
  57     return civicrm_api3_create_success($values);
  58   }
  59   return civicrm_api3_create_error('Subscription failed');
  60 }
  61
  62 /**
  63  * Adjust Metadata for Create action.
  64  *
  65  * The metadata is used for setting defaults, documentation & validation.
  66  *
  67  * @param array $params
  68  *   Array of parameters determined by getfields.
  69  */
  70 function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
  71   $params['email'] = [
  72     'api.required' => 1,
  73     'title' => 'Subscribe Email',
  74     'type' => CRM_Utils_Type::T_STRING,
  75   ];
  76   $params['group_id'] = [
  77     'api.required' => 1,
  78     'title' => 'Subscribe To Group',
  79     'type' => CRM_Utils_Type::T_INT,
  80   ];
  81 }