api/v3/MailingEventSubscribe.php

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