Checkstyle fix - one pesky whitespace

[civicrm-core.git] / api / v3 / MailingEventConfirm.php

diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php
index 6f45668e0fd4ab0cccc1a90e3f0194cc63f95415..c36deae8bd01ca1e2558ab94d184fc624c18b906 100644 (file)
--- a/api/v3/MailingEventConfirm.php
+++ b/api/v3/MailingEventConfirm.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,31 +23,24 @@
  | 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$
- *
  */
 
 /**
- * Handle a confirm event
+ * Handle a confirm event.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'survey'
+ *   name/value pairs to insert in new 'survey'
  *
  * @throws Exception
  * @return array
-   *   api result array
- * {@getfields mailing_event_confirm_create}
- * @access public
+ *   api result array
  */
 function civicrm_api3_mailing_event_confirm_create($params) {
 
@@ -65,17 +57,27 @@ function civicrm_api3_mailing_event_confirm_create($params) {
 }
 
 /**
- * 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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_confirm_create_spec(&$params) {
-  $params['contact_id']['api.required'] = 1;
-  $params['contact_id']['title'] = 'Contact ID';
-  $params['subscribe_id']['api.required'] = 1;
-  $params['subscribe_id']['title'] = 'Subscribe Event ID';
-  $params['hash']['api.required'] = 1;
-  $params['hash']['title'] = 'Hash';
+  $params['contact_id'] = array(
+    'api.required' => 1,
+    'title' => 'Contact ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['subscribe_id'] = array(
+    'api.required' => 1,
+    'title' => 'Subscribe Event ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['hash'] = array(
+    'api.required' => 1,
+    'title' => 'Hash',
+    'type' => CRM_Utils_Type::T_STRING,
+  );
 }