comment fixes
[civicrm-core.git] / CRM / Contribute / Form / Task.php
index 2fd0a3565f9147f4965e12361d6e59901a84242c..423c67437a377bdbdd9a08ea573ea498b9e1a424 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | 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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
  */
 
 /**
- * This class generates form components for relationship
- *
+ * This class generates form components for relationship.
  */
 class CRM_Contribute_Form_Task extends CRM_Core_Form {
 
   /**
-   * The task being performed
+   * The task being performed.
    *
    * @var int
    */
   protected $_task;
 
   /**
-   * The additional clause that we restrict the search with
+   * The additional clause that we restrict the search with.
    *
    * @var string
    */
   protected $_componentClause = NULL;
 
   /**
-   * The array that holds all the component ids
+   * The array that holds all the component ids.
    *
    * @var array
    */
   protected $_componentIds;
 
   /**
-   * The array that holds all the contribution ids
+   * The array that holds all the contribution ids.
    *
    * @var array
    */
   protected $_contributionIds;
 
   /**
-   * The array that holds all the contact ids
+   * The array that holds all the contact ids.
    *
    * @var array
    */
   public $_contactIds;
 
   /**
-   * The array that holds all the mapping contribution and contact ids
+   * The array that holds all the mapping contribution and contact ids.
    *
    * @var array
    */
   protected $_contributionContactIds = array();
 
   /**
-   * The flag to tell if there are soft credits included
+   * The flag to tell if there are soft credits included.
    *
    * @var boolean
    */
   public $_includesSoftCredits = FALSE;
 
   /**
-   * Build all the data structures needed to build the form
-   *
-   * @param
-   *
-   * @return void
+   * Build all the data structures needed to build the form.
    */
   public function preProcess() {
     self::preProcessCommon($this);
@@ -123,7 +116,7 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
     else {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
-      if ($form->get(CRM_Utils_Sort::SORT_ORDER )) {
+      if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
       }
 
@@ -178,8 +171,8 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
     }
     else {
       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
-          $urlParams
-        ));
+        $urlParams
+      ));
     }
   }
 
@@ -206,8 +199,6 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
    *   Button type for the form after processing.
    * @param string $backType
    * @param bool $submitOnce
-   *
-   * @return void
    */
   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
     $this->addButtons(array(
@@ -223,4 +214,5 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
       )
     );
   }
+
 }