<?php
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* APIv3 functions for registering/processing mailing group events.
*
* @package CiviCRM_APIv3
- * @subpackage API_MailerGroup
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
*/
/**
- * Subscribe from mailing group
+ * Subscribe from mailing group.
*
- * @param array $params Associative array of property
- * name/value pairs to insert in new 'survey'
+ * @param array $params
+ * Array per getfields metadata.
*
* @throws API_Exception
- * @return array api result array
- * {@getfields mailing_event_subscribe_create}
- * @access public
+ * @return array
+ * api result array
*/
function civicrm_api3_mailing_event_subscribe_create($params) {
$email = $params['email'];
$group = new CRM_Contact_DAO_Group();
$group->is_active = 1;
- $group->id = (int)$group_id;
+ $group->id = (int) $group_id;
if (!$group->find(TRUE)) {
throw new API_Exception('Invalid Group id');
}
if ($subscribe !== NULL) {
/* Ask the contact for confirmation */
-
$subscribe->send_confirm_request($email);
$values = array();
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_mailing_event_subscribe_create_spec(&$params) {
- $params['email']['api.required'] = 1;
- $params['email']['title'] = 'Unsubscribe Email';
- $params['group_id']['api.required'] = 1;
- $params['group_id']['title'] = 'Unsubscribe From Group';
+ $params['email'] = array(
+ 'api.required' => 1,
+ 'title' => 'Unsubscribe Email',
+ 'type' => CRM_Utils_Type::T_STRING,
+ );
+ $params['group_id'] = array(
+ 'api.required' => 1,
+ 'title' => 'Unsubscribe From Group',
+ 'type' => CRM_Utils_Type::T_INT,
+ );
}
-