Merge pull request #6132 from colemanw/CRM-16795

[civicrm-core.git] / CRM / Utils / Sort.php

diff --git a/CRM/Utils/Sort.php b/CRM/Utils/Sort.php
index d993c69de1041c70f60719bac6a1731c7f46cf21..22d7d1b68ff963934dbef1fe22adff67c46c8b24 100644 (file)
--- a/CRM/Utils/Sort.php
+++ b/CRM/Utils/Sort.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | 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
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -41,7 +41,7 @@
  * if introducing additional functionality
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -122,7 +122,6 @@ class CRM_Utils_Sort {
    *   Order to sort.
    *
    * @return \CRM_Utils_Sort
-   * @access public
    */
   public function __construct(&$vars, $defaultSortOrder = NULL) {
     $this->_vars = array();
@@ -147,7 +146,7 @@ class CRM_Utils_Sort {
   }
 
   /**
-   * Function returns the string for the order by clause
+   * Function returns the string for the order by clause.
    *
    * @return string
    *   the order by clause
@@ -170,7 +169,7 @@ class CRM_Utils_Sort {
   }
 
   /**
-   * Create the sortID string to be used in the GET param
+   * Create the sortID string to be used in the GET param.
    *
    * @param int $index
    *   The field index.
@@ -179,14 +178,13 @@ class CRM_Utils_Sort {
    *
    * @return string
    *   the string to append to the url
-   * @static
    */
   public static function sortIDValue($index, $dir) {
     return ($dir == self::DESCENDING) ? $index . '_d' : $index . '_u';
   }
 
   /**
-   * Init the sort ID values in the object
+   * Init the sort ID values in the object.
    *
    * @param string $defaultSortOrder
    *   The sort order to use by default.
@@ -223,7 +221,7 @@ class CRM_Utils_Sort {
   }
 
   /**
-   * Init the object
+   * Init the object.
    *
    * @param string $defaultSortOrder
    *   The sort order to use by default.
@@ -259,7 +257,7 @@ class CRM_Utils_Sort {
   }
 
   /**
-   * Getter for currentSortID
+   * Getter for currentSortID.
    *
    * @return int
    *   returns of the current sort id
@@ -270,7 +268,7 @@ class CRM_Utils_Sort {
   }
 
   /**
-   * Getter for currentSortDirection
+   * Getter for currentSortDirection.
    *
    * @return int
    *   returns of the current sort direction
@@ -305,4 +303,5 @@ class CRM_Utils_Sort {
     // however, as I understand we don't want equality here:
     return -1;
   }
+
 }