Merge remote branch 'canonical/master' into merge-20140827
[civicrm-core.git] / CRM / Utils / Sort.php
index 7c93a5832dc497791cea78f4354e73c0d0ac8955..be88f6c436470f319f3b7e64a7603b481557c21b 100644 (file)
@@ -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$
  *
  */
@@ -41,7 +41,7 @@
  * if introducing additional functionality
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -116,11 +116,11 @@ class CRM_Utils_Sort {
    * key names of variable (which should be the same as the column name)
    * value: ascending or descending
    *
-   * @param mixed  $vars             - assoc array as described above
+   * @param mixed $vars - assoc array as described above
    * @param string $defaultSortOrder - order to sort
    *
-   * @return void
-   * @access public
+   * @return \CRM_Utils_Sort
+  @access public
    */
   function __construct(&$vars, $defaultSortOrder = NULL) {
     $this->_vars = array();
@@ -277,6 +277,9 @@ class CRM_Utils_Sort {
   /**
    * Universal callback function for sorting by weight
    *
+   * @param $a
+   * @param $b
+   *
    * @return array of items sorted by weight
    * @access public
    */