CRM-15988 - Cleanup internal use of entity names

[civicrm-core.git] / CRM / Core / Selector / Controller.php

diff --git a/CRM/Core/Selector/Controller.php b/CRM/Core/Selector/Controller.php
index 534cef9eb49c1a613cc031ba4359c588ef37e8de..6a1577fba0aca53744d2004b462b1dba8cf7084f 100644 (file)
--- a/CRM/Core/Selector/Controller.php
+++ b/CRM/Core/Selector/Controller.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        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -48,10 +48,10 @@ class CRM_Core_Selector_Controller {
    */
   // move the values from the session to the template
   const SESSION = 1, TEMPLATE = 2,
-  TRANSFER = 4, EXPORT = 8, SCREEN = 16, PDF = 32;
+    TRANSFER = 4, EXPORT = 8, SCREEN = 16, PDF = 32;
 
   /**
-   * A CRM Object that implements CRM_Core_Selector_API
+   * A CRM Object that implements CRM_Core_Selector_API.
    * @var object
    */
   protected $_object;
@@ -119,7 +119,7 @@ class CRM_Core_Selector_Controller {
    * so the display routine needs to not do any work. (The
    * parent object takes care of the display)
    *
-   * @var boolean
+   * @var bool
    */
   protected $_embedded = FALSE;
 
@@ -127,7 +127,7 @@ class CRM_Core_Selector_Controller {
    * Are we in print mode? if so we need to modify the display
    * functionality to do a minimal display :)
    *
-   * @var boolean
+   * @var bool
    */
   protected $_print = FALSE;
 
@@ -163,19 +163,18 @@ class CRM_Core_Selector_Controller {
    * Array of properties that the controller dumps into the output object
    *
    * @var array
-   * @static
    */
   public static $_properties = array('columnHeaders', 'rows', 'rowsEmpty');
 
   /**
    * Should we compute actions dynamically (since they are quite verbose)
    *
-   * @var boolean
+   * @var bool
    */
   protected $_dynamicAction = FALSE;
 
   /**
-   * Class constructor
+   * Class constructor.
    *
    * @param CRM_Core_Selector_API $object
    *   An object that implements the selector API.
@@ -193,7 +192,6 @@ class CRM_Core_Selector_Controller {
    * @param null $case
    *
    * @return \CRM_Core_Selector_Controller
-   * @access public
    */
   public function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
 
@@ -201,10 +199,10 @@ class CRM_Core_Selector_Controller {
     $this->_pageID = $pageID ? $pageID : 1;
     $this->_sortID = $sortID ? $sortID : NULL;
     $this->_action = $action;
-    $this->_store  = $store;
+    $this->_store = $store;
     $this->_output = $output;
     $this->_prefix = $prefix;
-    $this->_case   = $case;
+    $this->_case = $case;
 
     // fix sortID
     if ($this->_sortID && strpos($this->_sortID, '_') === FALSE) {
@@ -260,7 +258,7 @@ class CRM_Core_Selector_Controller {
    * @param int $reset
    *   Are we being reset.
    *
-   * @return boolean
+   * @return bool
    *   if the GET params are different from the session params
    */
   public function hasChanged($reset) {
@@ -342,8 +340,8 @@ class CRM_Core_Selector_Controller {
       $rows = self::getRows($this);
       CRM_Utils_Hook::searchColumns($contextName, $columnHeaders, $rows, $this);
       $rowsEmpty = count($rows) ? FALSE : TRUE;
-      $qill      = $this->getQill();
-      $summary   = $this->getSummary();
+      $qill = $this->getQill();
+      $summary = $this->getSummary();
       // if we need to store in session, lets update session
       if ($this->_output & self::SESSION) {
         $this->_store->set("{$this->_prefix}columnHeaders", $columnHeaders);
@@ -392,7 +390,7 @@ class CRM_Core_Selector_Controller {
    * @param CRM_Core_Form $form
    *
    * @return array
-   *   of rows
+   *   Array of rows
    */
   public function getRows($form) {
     if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) {
@@ -425,7 +423,7 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Getter for pager
+   * Getter for pager.
    *
    * @return CRM_Utils_Pager
    */
@@ -434,7 +432,7 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Getter for sort
+   * Getter for sort.
    *
    * @return CRM_Utils_Sort
    */
@@ -443,7 +441,7 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Move the variables from the session to the template
+   * Move the variables from the session to the template.
    *
    * @return void
    */
@@ -485,7 +483,7 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Setter for embedded
+   * Setter for embedded.
    *
    * @param bool $embedded
    *
@@ -496,9 +494,9 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Getter for embedded
+   * Getter for embedded.
    *
-   * @return boolean
+   * @return bool
    *   return the embedded value
    */
   public function getEmbedded() {
@@ -506,7 +504,7 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Setter for print
+   * Setter for print.
    *
    * @param bool $print
    *
@@ -517,9 +515,9 @@ class CRM_Core_Selector_Controller {
   }
 
   /**
-   * Getter for print
+   * Getter for print.
    *
-   * @return boolean
+   * @return bool
    *   return the print value
    */
   public function getPrint() {
@@ -539,4 +537,5 @@ class CRM_Core_Selector_Controller {
   public function getDynamicAction() {
     return $this->_dynamicAction;
   }
+
 }