Mass cleanup of docblocks/code/comments

[civicrm-core.git] / CRM / Pledge / Selector / Search.php

diff --git a/CRM/Pledge/Selector/Search.php b/CRM/Pledge/Selector/Search.php
index 71e0ca60d2d8fde8d5acb81c25c17145b7438aff..e6755b2afe912d71e4632fe76ded7444ca1b6f2b 100644 (file)
--- a/CRM/Pledge/Selector/Search.php
+++ b/CRM/Pledge/Selector/Search.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -140,14 +140,16 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
   /**
    * Class constructor
    *
-   * @param array   $queryParams array of parameters for query
-   * @param int     $action - action of search basic or advanced.
-   * @param string  $additionalClause if the caller wants to further restrict the search (used in participations)
+   * @param array $queryParams array of parameters for query
+   * @param \const|int $action - action of search basic or advanced.
+   * @param string $additionalClause if the caller wants to further restrict the search (used in participations)
    * @param boolean $single are we dealing only with one contact?
-   * @param int     $limit  how many signers do we want returned
+   * @param int $limit how many signers do we want returned
    *
-   * @return CRM_Contact_Selector
-   * @access public
+   * @param string $context
+   *
+   * @return \CRM_Pledge_Selector_Search
+  @access public
    */
   function __construct(&$queryParams,
     $action           = CRM_Core_Action::NONE,
@@ -175,7 +177,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
     $this->_query->_distinctComponentClause = "civicrm_pledge.id";
     $this->_query->_groupByComponentClause = " GROUP BY civicrm_pledge.id ";
   }
-  //end of constructor
 
   /**
    * This method returns the links that are given for each search row.
@@ -231,12 +232,13 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
 
     return self::$_links;
   }
-  //end of function
 
   /**
    * getter for array of the parameters required for creating pager.
    *
-   * @param
+   * @param $action
+   * @param array $params
+   *
    * @access public
    */
   function getPagerParams($action, &$params) {
@@ -252,7 +254,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
     $params['buttonTop'] = 'PagerTopButton';
     $params['buttonBottom'] = 'PagerBottomButton';
   }
-  //end of function
 
   /**
    * Returns total number of rows for the query.
@@ -366,7 +367,6 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
   }
 
   /**
-   *
    * @return array  $qill    which contains an array of strings
    * @access public
    */
@@ -433,7 +433,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
 
       if (!$this->_single) {
         $pre = array(
-          array('desc' => ts('Contact Id')),
+          array('desc' => ts('Contact ID')),
           array(
             'name' => ts('Name'),
             'sort' => 'sort_name',
@@ -447,6 +447,9 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
     return self::$_columnHeaders;
   }
 
+  /**
+   * @return string
+   */
   function &getQuery() {
     return $this->_query;
   }
@@ -462,5 +465,4 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
     return ts('Pledge Search');
   }
 }
-//end of class