* @version 1.6.2
*/
require_once dirname(__FILE__) . '/Prefs.inc.php';
class SortOrder {
var $_columns;
var $sort_by;
var $order;
var $asc_widget = '![[ASC]](/admin/_widgets/sort_ascending.gif)
';
var $desc_widget = '![[DESC]](/admin/_widgets/sort_descending.gif)
';
var $default_sort;
var $default_order;
/**
* Constructor. Finds the current sort by and order.
*
* @param string $default_sort If not found elsewhere, this will be the
* current sort by.
* @param string $default_order If not found elsewhere, this will be the
* current order.
*/
function SortOrder($default_sort = '', $default_order = '')
{
$this->setDefault($default_sort, $default_order);
$this->default_sort = $default_sort;
$this->default_order = $default_order;
}
/**
* Build an array of valid sort SQL for each DB column. This SQL is reference
* by the name and 'asc' or 'desc'.
*
* @param string $name Reference name for the column this SQL sorts on.
* @param string $asc_sql The sort SQL if $this->order is ascending.
* @param string $desc_sql The sort SQL if $this->order is descending.
*/
function setColumn($name, $asc_sql, $desc_sql)
{
$this->_columns[$name] = array(
'asc' => $asc_sql,
'desc' => $desc_sql
);
}
/**
* Set sort and order values. This is how you set new sort values after
* already declaring a SortOrder object, but expect values to come from
* getFormData.
*
* @param string $default_sort If not found elsewhere, this will be the
* current sort by.
* @param string $default_order If not found elsewhere, this will be the
* current order.
*/
function setDefault($default_sort = '', $default_order = '')
{
$prefs =& Prefs::getInstance();
// Which column to sort by?
// (1) By GET or POST specification, if available.
// (2) By saved preference, if available.
// (3) By default (provided at class instantiation).
$new_sort_by = getFormData('sort');
if (!empty($new_sort_by)) {
$this->sort_by = $new_sort_by;
$prefs->set('sort_by', $this->sort_by, $_SERVER['PHP_SELF']);
} else if ($prefs->exists('sort_by', $_SERVER['PHP_SELF'])) {
$this->sort_by = $prefs->get('sort_by', $_SERVER['PHP_SELF']);
} else {
$this->sort_by = $default_sort;
}
// Which sort order to use?
// (1) By GET or POST specification, if available.
// (2) By saved preference, if available.
// (3) By default (provided at class instanciation).
$new_order = getFormData('order');
if (!empty($new_order)) {
$this->order = $new_order;
$prefs->set('sort_order', $this->order, $_SERVER['PHP_SELF']);
} else if ($prefs->exists('sort_order', $_SERVER['PHP_SELF'])) {
$this->order = $prefs->get('sort_order', $_SERVER['PHP_SELF']);
} else {
$this->order = $default_order;
}
}
/**
* Forcibly set sort and order values. This is how you set new sort values after
* already declaring a SortOrder object. This will ignore getFormData values.
*
* @param string $sort The sort by name.
* @param string $order The order direction (ASC,
* for example, for an alphabetical sort)
*/
function set($sort = null, $order = null)
{
$prefs =& Prefs::getInstance();
// Set new sort value.
if (isset($sort)) {
$this->sort_by = $sort;
$prefs->set('sort_by', $this->sort_by, $_SERVER['PHP_SELF']);
}
// Set new order value.
if (isset($order)) {
$this->order = $order;
$prefs->set('sort_order', $this->order, $_SERVER['PHP_SELF']);
}
}
/**
* Returns the SQL code to sort by set column and set order.
*/
function getSortOrderSQL()
{
$app =& App::getInstance();
$db =& DB::getInstance();
if (!isset($this->_columns[strtolower($this->sort_by)])) {
$this->sort_by = $this->default_sort;
$this->order = $this->default_order;
}
if (!isset($this->_columns[strtolower($this->sort_by)][strtolower($this->order)])) {
$this->order = 'ASC';
}
if (!empty($this->_columns[strtolower($this->sort_by)][strtolower($this->order)])) {
return sprintf(' ORDER BY %s ', $db->escapeString($this->_columns[strtolower($this->sort_by)][strtolower($this->order)]));
} else {
$app->logMsg(sprintf('Could not find SQL to sort by %s %s.', $this->sort_by, $this->order), LOG_WARNING, __FILE__, __LINE__);
return '';
}
}
/**
* Prints a link for a column header with URL sort determining logic.
*
* @param string $col The database column to sort by.
* @param string $col_name The human-readable title of the column.
* @param string $default_order The default order for this column (ASC,
* for example, for an alphabetical sort)
*/
function printSortHeader($col, $col_name, $default_order='ASC')
{
$app =& App::getInstance();
if ($this->sort_by == $col) {
if (strtolower($this->order) == 'desc') {
?>">desc_widget; ?>">asc_widget; ?>">