comment fixes

[civicrm-core.git] / CRM / Contribute / Form / Task.php

diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php
index 117a00c2d78df57af23e36baede4c93effebfb6a..423c67437a377bdbdd9a08ea573ea498b9e1a424 100644 (file)
--- a/CRM/Contribute/Form/Task.php
+++ b/CRM/Contribute/Form/Task.php
@@ -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.                                    |
  |                                                                    |
@@ -23,77 +23,70 @@
  | 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);
@@ -122,9 +115,9 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
     }
     else {
       $queryParams = $form->get('queryParams');
-      $sortOrder = null;
-      if ( $form->get( CRM_Utils_Sort::SORT_ORDER  ) ) {
-        $sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER );
+      $sortOrder = NULL;
+      if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
+        $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
       }
 
       $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
@@ -135,7 +128,8 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
         $contactIds = $contributionContactIds = array();
         $query->_rowCountClause = " count(civicrm_contribution.id)";
         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
-      } else {
+      }
+      else {
         $query->_distinctComponentClause = ' civicrm_contribution.id';
         $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id ';
       }
@@ -177,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
+      ));
     }
   }
 
@@ -199,12 +193,12 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
    * Simple shell that derived classes can call to add buttons to
    * the form with a customized title for the main Submit
    *
-   * @param string $title title of the main button
-   * @param string $nextType button type for the form after processing
+   * @param string $title
+   *   Title of the main button.
+   * @param string $nextType
+   *   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(
@@ -220,4 +214,5 @@ class CRM_Contribute_Form_Task extends CRM_Core_Form {
       )
     );
   }
+
 }