class CRM_Utils_Sort {
/**
- * constants to determine what direction each variable
+ * Constants to determine what direction each variable
* is to be sorted
*
* @var int
CONST ASCENDING = 1, DESCENDING = 2, DONTCARE = 4,
/**
- * the name for the sort GET/POST param
+ * 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
+ * Name of the sort function. Used to isolate session variables
* @var string
*/
protected $_name;
/**
- * array of variables that influence the query
+ * Array of variables that influence the query
*
* @var array
*/
public $_vars;
/**
- * the newly formulated base url to be used as links
+ * The newly formulated base url to be used as links
* for various table elements
*
* @var string
protected $_link;
/**
- * what's the name of the sort variable in a REQUEST
+ * What's the name of the sort variable in a REQUEST
*
* @var string
*/
* 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();
$this->_currentSortDirection = $this->_vars[$this->_currentSortID]['direction'];
}
$this->_urlVar = self::SORT_ID;
- $this->_link = CRM_Utils_System::makeURL($this->_urlVar);
+ $this->_link = CRM_Utils_System::makeURL($this->_urlVar, TRUE);
$this->initialize($defaultSortOrder);
}
}
/**
- * 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
}
/**
- * 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
*
}
/**
- * 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
* @acccess public
}
/**
- * getter for currentSortDirection
+ * Getter for currentSortDirection
*
* @return int returns of the current sort direction
* @acccess public
/**
* Universal callback function for sorting by weight
*
+ * @param $a
+ * @param $b
+ *
* @return array of items sorted by weight
* @access public
*/