api/v3/MailingEventSubscribe.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  *
  32  * APIv3 functions for registering/processing mailing group events.
  33  *
  34  * @package CiviCRM_APIv3
  35  * @subpackage API_MailerGroup
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * $Id$
  38  *
  39  */
  40
  41 /**
  42  * Subscribe from mailing group
  43  *
  44  * @param array $params  Associative array of property
  45  *                       name/value pairs to insert in new 'survey'
  46  *
  47  * @return array api result array
  48  * {@getfields mailing_event_subscribe_create}
  49  * @access public
  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     return civicrm_api3_create_error('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
  69     $subscribe->send_confirm_request($email);
  70
  71     $values = array();
  72     $values['contact_id'] = $subscribe->contact_id;
  73     $values['subscribe_id'] = $subscribe->id;
  74     $values['hash'] = $subscribe->hash;
  75     $values['is_error'] = 0;
  76
  77     return civicrm_api3_create_success($values);
  78   }
  79   return civicrm_api3_create_error('Subscription failed');
  80 }
  81
  82 /**
  83  * Adjust Metadata for Create action
  84  *
  85  * The metadata is used for setting defaults, documentation & validation
  86  * @param array $params array or parameters determined by getfields
  87  */
  88 function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
  89   $params['email']['api.required'] = 1;
  90   $params['group_id']['api.required'] = 1;
  91 }
  92