+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| 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$
*
*/
* if introducing additional functionality
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
*/
const ASCENDING = 1, DESCENDING = 2, DONTCARE = 4,
- /**
- * The name for the sort GET/POST param
- *
- * @var string
- */
- SORT_ID = 'crmSID', SORT_DIRECTION = 'crmSortDirection', SORT_ORDER = 'crmSortOrder';
+ /**
+ * The name for the sort GET/POST param
+ *
+ * @var string
+ */
+ SORT_ID = 'crmSID', SORT_DIRECTION = 'crmSortDirection', SORT_ORDER = 'crmSortOrder';
/**
* Name of the sort function. Used to isolate session variables
* Order to sort.
*
* @return \CRM_Utils_Sort
- @access public
*/
public function __construct(&$vars, $defaultSortOrder = NULL) {
$this->_vars = array();
}
/**
- * Function returns the string for the order by clause
+ * Function returns the string for the order by clause.
*
- * @return string the order by clause
+ * @return string
+ * the order by clause
*/
public function orderBy() {
if (empty($this->_vars[$this->_currentSortID])) {
}
/**
- * 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.
* @param int $dir
* The direction of the sort.
*
- * @return string the string to append to the url
- * @static
+ * @return string
+ * the string to append to the url
*/
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.
*
- * @return returns null if $url- (sort url) is not found
+ * @return void
*/
public function initSortID($defaultSortOrder) {
$url = CRM_Utils_Array::value(self::SORT_ID, $_GET, $defaultSortOrder);
}
/**
- * Init the object
+ * Init the object.
*
* @param string $defaultSortOrder
* The sort order to use by default.
}
/**
- * Getter for currentSortID
+ * Getter for currentSortID.
*
- * @return int returns of the current sort id
+ * @return int
+ * returns of the current sort id
* @acccess public
*/
public function getCurrentSortID() {
}
/**
- * Getter for currentSortDirection
+ * Getter for currentSortDirection.
*
- * @return int returns of the current sort direction
+ * @return int
+ * returns of the current sort direction
* @acccess public
*/
public function getCurrentSortDirection() {
* @param $a
* @param $b
*
- * @return int (-1 or 1)
+ * @return int
+ * (-1 or 1)
*/
public static function cmpFunc($a, $b) {
$cmp_order = array('weight', 'id', 'title', 'name');
// however, as I understand we don't want equality here:
return -1;
}
+
}