api/v3/MailingEventResubscribe.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  */
  34
  35 /**
  36  * Subscribe from mailing group.
  37  *
  38  * @param array $params
  39  *
  40  * @return array
  41  *   api result array
  42  */
  43 function civicrm_api3_mailing_event_resubscribe_create($params) {
  44
  45   $groups = CRM_Mailing_Event_BAO_Resubscribe::resub_to_mailing(
  46     $params['job_id'],
  47     $params['event_queue_id'],
  48     $params['hash']
  49   );
  50
  51   if (count($groups)) {
  52     CRM_Mailing_Event_BAO_Resubscribe::send_resub_response(
  53       $params['event_queue_id'],
  54       $groups, FALSE,
  55       $params['job_id']
  56     );
  57     return civicrm_api3_create_success($params);
  58   }
  59   return civicrm_api3_create_error('Queue event could not be found');
  60 }
  61
  62 /**
  63  * Adjust Metadata for Create action.
  64  *
  65  * The metadata is used for setting defaults, documentation & validation.
  66  *
  67  * @param array $params
  68  *   Array of parameters determined by getfields.
  69  */
  70 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
  71   $params['event_queue_id']['api.required'] = 1;
  72   $params['event_queue_id']['title'] = 'Event Queue ID';
  73   $params['job_id']['api.required'] = 1;
  74   $params['job_id']['title'] = 'Job ID';
  75   $params['hash']['api.required'] = 1;
  76   $params['hash']['title'] = 'Hash';
  77 }