api/v3/MailingEventResubscribe.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  * @return array
  48  *   api result array
  49  * {@getfields mailing_event_subscribe_create}
  50  * @access public
  51  */
  52 function civicrm_api3_mailing_event_resubscribe_create($params) {
  53
  54   $groups = CRM_Mailing_Event_BAO_Resubscribe::resub_to_mailing(
  55     $params['job_id'],
  56     $params['event_queue_id'],
  57     $params['hash']
  58   );
  59
  60   if (count($groups)) {
  61     CRM_Mailing_Event_BAO_Resubscribe::send_resub_response(
  62       $params['event_queue_id'],
  63       $groups, FALSE,
  64       $params['job_id']
  65     );
  66     return civicrm_api3_create_success($params);
  67   }
  68   return civicrm_api3_create_error('Queue event could not be found');
  69 }
  70
  71 /**
  72  * Adjust Metadata for Create action
  73  *
  74  * The metadata is used for setting defaults, documentation & validation
  75  * @param array $params
  76  *   Array or parameters determined by getfields.
  77  */
  78 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
  79   $params['event_queue_id']['api.required'] = 1;
  80   $params['event_queue_id']['title'] = 'Event Queue ID';
  81   $params['job_id']['api.required'] = 1;
  82   $params['job_id']['title'] = 'Job ID';
  83   $params['hash']['api.required'] = 1;
  84   $params['hash']['title'] = 'Hash';
  85 }