INFRA-132 add full stops

[civicrm-core.git] / CRM / Core / QuickForm / Action / Upload.php

diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php
index 05db31e4e94cfcf9cdda4f6119dab2c2b6431983..63fd54335d173a871621ff1aed9d7d5049664062 100644 (file)
--- a/CRM/Core/QuickForm/Action/Upload.php
+++ b/CRM/Core/QuickForm/Action/Upload.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Redefine the upload action.
@@ -31,24 +31,23 @@
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
- *
  */
 class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
 
   /**
-   * The array of uploaded file names
+   * The array of uploaded file names.
    * @var array
    */
   protected $_uploadNames;
 
   /**
-   * The directory to store the uploaded files
+   * The directory to store the uploaded files.
    * @var string
    */
   protected $_uploadDir;
 
   /**
-   * Class constructor
+   * Class constructor.
    *
    * @param object $stateMachine
    *   Reference to state machine object.
@@ -58,7 +57,6 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
    *   Element names of the various uploadable files.
    *
    * @return \CRM_Core_QuickForm_Action_Upload
-   * @access public
    */
   public function __construct(&$stateMachine, $uploadDir, $uploadNames) {
     parent::__construct($stateMachine);
@@ -68,7 +66,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
   }
 
   /**
-   * Upload and move the file if valid to the uploaded directory
+   * Upload and move the file if valid to the uploaded directory.
    *
    * @param CRM_Core_Form $page
    *   The CRM_Core_Form object.
@@ -78,8 +76,6 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
    *   The name of the page which index the data container with.
    * @param string $uploadName
    *   The name of the uploaded file.
-   *
-   * @return void
    */
   public function upload(&$page, &$data, $pageName, $uploadName) {
     // make sure uploadName exists in the QF array
@@ -102,7 +98,7 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
         if (!$status) {
           CRM_Core_Error::statusBounce(ts('We could not move the uploaded file %1 to the upload directory %2. Please verify that the \'Temporary Files\' setting points to a valid path which is writable by your web server.', array(
                 1 => $value['name'],
-                2 => $this->_uploadDir
+                2 => $this->_uploadDir,
               )));
         }
         if (!empty($data['values'][$pageName][$uploadName]['name'])) {
@@ -124,8 +120,6 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
    *   CRM_Core_Form the current form-page.
    * @param string $actionName
    *   Current action name, as one Action object can serve multiple actions.
-   *
-   * @return void
    */
   public function perform(&$page, $actionName) {
     // like in Action_Next
@@ -135,11 +129,15 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
     // the above buildForm potentially changes the action function with different args
     // so basically the rug might have been pulled from us, so we actually just check
     // and potentially call the right one
-    // this allows standalong form uploads to work nicely
+    // this allows standalone form uploads to work nicely
     $page->controller->_actions['upload']->realPerform($page, $actionName);
   }
 
   /**
+   * Real perform.
+   *
+   * @todo document what I do.
+   *
    * @param CRM_Core_Form $page
    * @param string $actionName
    *
@@ -177,4 +175,5 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
       return $state->handleNextState($page);
     }
   }
+
 }