api/v3/MailingEventSubscribe.php

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