X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailingEventResubscribe.php;h=9a958d72a4afeda5e85436b06aea862245585b85;hb=3b7bf9514d92a68e9adb10ae1fe33f8d6ca3da7d;hp=60427511368f8cd46778a4279d352bb4a7ddbb55;hpb=13c1cf91881e22bbcc38024c645736a3fc6fad4a;p=civicrm-core.git

diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php
index 6042751136..9a958d72a4 100644
--- a/api/v3/MailingEventResubscribe.php
+++ b/api/v3/MailingEventResubscribe.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -24,28 +23,22 @@
  | 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-2013
- * $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
  *
- * @return array api result array
- * {@getfields mailing_event_subscribe_create}
- * @access public
+ * @return array
+ *   api result array
  */
 function civicrm_api3_mailing_event_resubscribe_create($params) {
 
@@ -67,14 +60,27 @@ function civicrm_api3_mailing_event_resubscribe_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
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
-  $params['event_queue_id']['api.required'] = 1;
-  $params['job_id']['api.required'] = 1;
-  $params['hash']['api.required'] = 1;
+  $params['event_queue_id'] = array(
+    'api.required' => 1,
+    'title' => 'Event Queue ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['job_id'] = array(
+    'api.required' => 1,
+    'title' => 'Job ID',
+    'type' => CRM_Utils_Type::T_INT,
+  );
+  $params['hash'] = array(
+    'api.required' => 1,
+    'title' => 'Hash',
+    'type' => CRM_Utils_Type::T_STRING,
+  );
 }
-