crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/MailingEventUnsubscribe.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * Unsubscribe from mailing group.
  37  *
  38  * @param array $params
  39  *   Array per getfields metadata.
  40  *
  41  * @return array
  42  *   Api result array
  43  */
  44 function civicrm_api3_mailing_event_unsubscribe_create($params) {
  45
  46   $job = $params['job_id'];
  47   $queue = $params['event_queue_id'];
  48   $hash = $params['hash'];
  49   if (empty($params['org_unsubscribe'])) {
  50     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job, $queue, $hash);
  51     if (count($groups)) {
  52       CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, $groups, FALSE, $job);
  53       return civicrm_api3_create_success($params);
  54     }
  55   }
  56   else {
  57     $unsubs = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_domain($job, $queue, $hash);
  58     if (!$unsubs) {
  59       return civicrm_api3_create_error('Domain Queue event could not be found');
  60     }
  61
  62     CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($queue, NULL, TRUE, $job);
  63     return civicrm_api3_create_success($params);
  64   }
  65
  66   return civicrm_api3_create_error('Queue event could not be found');
  67 }
  68
  69 /**
  70  * Adjust Metadata for Create action.
  71  *
  72  * The metadata is used for setting defaults, documentation & validation.
  73  *
  74  * @param array $params
  75  *   Array of parameters determined by getfields.
  76  */
  77 function _civicrm_api3_mailing_event_unsubscribe_create_spec(&$params) {
  78   $params['job_id'] = array(
  79     'api.required' => 1,
  80     'title' => 'Mailing Job ID',
  81     'type' => CRM_Utils_Type::T_INT,
  82   );
  83   $params['hash'] = array(
  84     'api.required' => 1,
  85     'title' => 'Mailing Hash',
  86     'type' => CRM_Utils_Type::T_STRING,
  87   );
  88   $params['event_queue_id'] = array(
  89     'api.required' => 1,
  90     'title' => 'Mailing Queue ID',
  91     'type' => CRM_Utils_Type::T_INT,
  92   );
  93 }