api/v3/MailingEventSubscribe.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * @subpackage API_MailerGroup
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38
  39 /**
  40  * Subscribe from mailing group
  41  *
  42  * @param array $params
  43  *   Associative array of property.
  44  *                       name/value pairs to insert in new 'survey'
  45  *
  46  * @throws API_Exception
  47  * @return array
  48  *   api result array
  49  *   {@getfields mailing_event_subscribe_create}
  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)) {
  60     throw new API_Exception('Invalid Group id');
  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     $subscribe->send_confirm_request($email);
  69
  70     $values = array();
  71     $values[$subscribe->id]['contact_id'] = $subscribe->contact_id;
  72     $values[$subscribe->id]['subscribe_id'] = $subscribe->id;
  73     $values[$subscribe->id]['hash'] = $subscribe->hash;
  74
  75     return civicrm_api3_create_success($values);
  76   }
  77   return civicrm_api3_create_error('Subscription failed');
  78 }
  79
  80 /**
  81  * Adjust Metadata for Create action
  82  *
  83  * The metadata is used for setting defaults, documentation & validation
  84  * @param array $params
  85  *   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['email']['title'] = 'Unsubscribe Email';
  90   $params['group_id']['api.required'] = 1;
  91   $params['group_id']['title'] = 'Unsubscribe From Group';
  92 }