Merge pull request #6170 from colemanw/CRM-16354

[civicrm-core.git] / CRM / Utils / Wrapper.php

diff --git a/CRM/Utils/Wrapper.php b/CRM/Utils/Wrapper.php
index 956215b234f73622f0036687b1ae31ffb822e899..588eed272b40c4684b8cc2180e399acab922c97f 100644 (file)
--- a/CRM/Utils/Wrapper.php
+++ b/CRM/Utils/Wrapper.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * The Contact Wrapper is a wrapper class which is called by
@@ -33,14 +33,14 @@
  * run method as explained below.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id: $
  *
  */
 class CRM_Utils_Wrapper {
 
   /**
-   * Simple Controller
+   * Simple Controller.
    *
    * The controller which will handle the display and processing of this page.
    */
@@ -52,11 +52,12 @@ class CRM_Utils_Wrapper {
    * The heart of the callback processing is done by this method.
    * forms are of different type and have different operations.
    *
-   * @param string formName name of the form processing this action
-   * @param string formLabel label for the above form
-   * @param int mode mode of operation.
-   * @param bool addSequence should we add a unique sequence number to the end of the key
-   * @param bool ignoreKey should we not set a qfKey for this controller (for standalone forms)
+   * @param string $formName name of the form processing this action
+   * @param string $formLabel label for the above form
+   * @param array $arguments
+   *  - int mode: mode of operation.
+   *  - bool addSequence: should we add a unique sequence number to the end of the key
+   *  - bool ignoreKey: should we not set a qfKey for this controller (for standalone forms)
    *
    * @return void
    */
@@ -113,4 +114,5 @@ class CRM_Utils_Wrapper {
     $this->_controller->process();
     return $this->_controller->run();
   }
+
 }