api/v3/MailingEventConfirm.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   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  * Handle a confirm event
  42  *
  43  * @param array $params Associative array of property
  44  *                       name/value pairs to insert in new 'survey'
  45  *
  46  * @throws Exception
  47  * @return array api result array
  48  * {@getfields mailing_event_confirm_create}
  49  * @access public
  50  */
  51 function civicrm_api3_mailing_event_confirm_create($params) {
  52
  53   $contact_id   = $params['contact_id'];
  54   $subscribe_id = $params['subscribe_id'];
  55   $hash         = $params['hash'];
  56
  57   $confirm = CRM_Mailing_Event_BAO_Confirm::confirm($contact_id, $subscribe_id, $hash) !== FALSE;
  58
  59   if (!$confirm) {
  60     throw new Exception('Confirmation failed');
  61   }
  62   return civicrm_api3_create_success($params);
  63 }
  64
  65 /**
  66  * Adjust Metadata for Create action
  67  *
  68  * The metadata is used for setting defaults, documentation & validation
  69  * @param array $params array or parameters determined by getfields
  70  */
  71 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
  72   $params['contact_id']['api.required'] = 1;
  73   $params['subscribe_id']['api.required'] = 1;
  74   $params['hash']['api.required'] = 1;
  75 }
  76