Merge branch 'phpunit-ob-fix' of https://github.com/giant-rabbit/civicrm-core into...

[civicrm-core.git] / CRM / Contact / Selector / Custom.php

diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php
index bb28ea8f7851a6439b9bd2aefb63566cf495c6ae..afaa3f82e9e8bdc7406fc0447b13a88f2e0a82de 100644 (file)
--- a/CRM/Contact/Selector/Custom.php
+++ b/CRM/Contact/Selector/Custom.php
@@ -50,7 +50,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   static $_links = NULL;
 
   /**
-   * we use desc to remind us what that column is, name is used in the tpl
+   * We use desc to remind us what that column is, name is used in the tpl
    *
    * @var array
    * @static
@@ -65,7 +65,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   static $_properties = array('contact_id', 'contact_type', 'display_name');
 
   /**
-   * formValues is the array returned by exportValues called on
+   * FormValues is the array returned by exportValues called on
    * the HTML_QuickForm_Controller for that page.
    *
    * @var array
@@ -74,7 +74,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   public $_formValues;
 
   /**
-   * params is the array in a value used by the search query creator
+   * Params is the array in a value used by the search query creator
    *
    * @var array
    * @access protected
@@ -82,7 +82,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   public $_params;
 
   /**
-   * represent the type of selector
+   * Represent the type of selector
    *
    * @var int
    * @access protected
@@ -92,7 +92,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   protected $_query;
 
   /**
-   * the public visible fields to be shown to the user
+   * The public visible fields to be shown to the user
    *
    * @var array
    * @access protected
@@ -157,7 +157,6 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
       $this->_search = new $className($formValues);
     }
   }
-  //end of constructor
 
   /**
    * This method returns the links that are given for each search row.
@@ -206,15 +205,13 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     }
     return self::$_links;
   }
-  //end of function
 
   /**
-   * getter for array of the parameters required for creating pager.
+   * Getter for array of the parameters required for creating pager.
    *
    * @param $action
-   * @param $params
+   * @param array $params
    *
-   * @internal param $
    * @access public
    */
   function getPagerParams($action, &$params) {
@@ -225,10 +222,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
     $params['buttonTop'] = 'PagerTopButton';
     $params['buttonBottom'] = 'PagerBottomButton';
   }
-  //end of function
 
   /**
-   * returns the column headers as an array of tuples:
+   * Returns the column headers as an array of tuples:
    * (name, sortName (key to the sort array))
    *
    * @param string $action the action being performed
@@ -273,7 +269,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   }
 
   /**
-   * returns all the rows in the given offset and rowCount
+   * Returns all the rows in the given offset and rowCount
    *
    * @param enum   $action   the action being performed
    * @param int    $offset   the row number to start from
@@ -398,7 +394,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   }
 
   /**
-   * name of export file.
+   * Name of export file.
    *
    * @param string $output type of output
    *
@@ -416,9 +412,9 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector {
   }
 
   /**
-   * @param $params
+   * @param array $params
    * @param $action
-   * @param $sortID
+   * @param int $sortID
    * @param null $displayRelationshipType
    * @param string $queryOperator
    *