Sorter Class Reference
[Controller]

Class to create a sorting widget and to process search results. More...

Inheritance diagram for Sorter:

List of all members.

Public Member Functions
	__construct (PageData $page_data, $columns, $default_column_key=false, $adapter=false)
	Constructor.
	apply ($query)
	Do what should be done.
	prepare_view ($view)
	Sets sorter_data on view, so WidgetSorter can be applied.
Static Public Member Functions
static	apply_to_url ($url, $column, $order)
	Prepare URL so filter gets applied.
Public Attributes
const	DO_INDEX_SORTED = 0
const	DONT_INDEX_SORTED = 1
Protected Attributes
	$adapter
	$sorter_data = array()

---

Detailed Description

Class to create a sorting widget and to process search results.

Author:

Gerd Riesselmann

Definition at line 8 of file sorter.cls.php.

---

Constructor & Destructor Documentation

Sorter::__construct	(	PageData $	page_data,
		$	columns,
		$	default_column_key = false,
		$	adapter = false
	)

Constructor.

Parameters:

	PageData	$page_data
	array|ISearchAdapter	$columns Associative array of DBSortColumns or instance of ISearchAdapter. In later case get_sortable_columns() and get_sort_default_column() are called on search adapter. Value of $default_column_key is ignored.
	string	$default_column Key for default sort column
	ISorterAdapter	$adapter If integer is passed it is interpreted as policy for backward compatability

Definition at line 37 of file sorter.cls.php.

                                                                                                                  {
                $this->adapter = ($adapter instanceof ISorterAdapter) ? $adapter : new SorterDefaultAdapter($page_data);
                if ($columns instanceof ISearchAdapter) {
                        $default_column_key = $columns->get_sort_default_column();
                        $columns = $columns->get_sortable_columns();
                }
                $this->sorter_data['policy'] = is_int($adapter) ? $adapter : 0;
                $this->sorter_data['page_data'] = $page_data;
                $this->sorter_data['column_objects'] = $columns;
                $this->sorter_data['columns_total'] = count($columns);
                $this->sorter_data['default_column_key'] = $default_column_key;
                
                // Get sort column objects
                $column_key =  $this->adapter->get_column();
                if (empty($column_key)) {
                        $column_key = $default_column_key;
                }
                $column_obj = Arr::get_item($columns, $column_key, false);
                if ($column_obj == false) {
                        $column_obj = Arr::get_item($columns, 0, false);
                }
                $this->sorter_data['current_column_key'] = $column_key;
                $this->sorter_data['current_column_object'] = $column_obj;

                // Set order
                $default_order = ($column_obj) ? $column_obj->get_direction() : DBSortColumn::ORDER_FORWARD;
                $order = $this->adapter->get_order();
                if (empty($order)) {
                        $order = $default_order;
                }
                else {
                        if ($column_obj && $column_obj->get_is_single_direction()) {
                                // Oops, we have a sort on a non-sortable column. Redirect
                                $this->adapter->get_url_for_sort($column_key, '')->redirect();
                                exit;                           
                        }
                }
                $this->sorter_data['order'] = $order;
                $this->sorter_data['default_order'] = $default_order;
                $this->sorter_data['is_default'] = (($order == $default_order) && ($column_key == $default_column_key));
        }

---

Member Function Documentation

Sorter::apply

(

$

query

)

Do what should be done.

Parameters:

DataObjectBase

The current query to be modified

Implements IDBQueryModifier.

Definition at line 84 of file sorter.cls.php.

                                      {
                $column_obj = $this->sorter_data['current_column_object'];
                if ($column_obj instanceof DBSortColumn) {
                        $column_obj->set_direction($this->sorter_data['order']);
                        $column_obj->apply($query);      
                }
        }

static Sorter::apply_to_url	(	$	url,
		$	column,
		$	order
	)			[static]

Prepare URL so filter gets applied.

Parameters:

	Url	Instance of URL class. This instance is changed.
	string	Filter to append

Returns:

void

Deprecated:

Use function on Adapter instead

Definition at line 164 of file sorter.cls.php.

                                                                   {
                return SorterDefaultAdapter::apply_to_url($url, $column, $order);
        }       

Sorter::prepare_view

(

$

view

)

Sets sorter_data on view, so WidgetSorter can be applied.

Definition at line 95 of file sorter.cls.php.

                                            {
                if ($this->sorter_data['columns_total'] < 2) {
                        return;
                }

                $order = $this->sorter_data['order']; 
                $arr_colums = array();
                foreach($this->sorter_data['column_objects'] as $column => $data) {
                        $arr_colums[$column] = $this->create_column_array($data, $order, $column);
                }

                $current_column_obj = $this->sorter_data['current_column_object']; 
                if ($current_column_obj) {
                        $current_column = $this->create_column_array($current_column_obj, $order, $this->sorter_data['current_column_key']);
                }

                $this->sorter_data['columns'] = $arr_colums;
                $this->sorter_data['current_column'] = $current_column;
                $view->assign('sorter_data', $this->sorter_data);
        }

---

Member Data Documentation

Sorter::$adapter [protected]

Definition at line 23 of file sorter.cls.php.

Sorter::$sorter_data = array() [protected]

Definition at line 24 of file sorter.cls.php.

const Sorter::DO_INDEX_SORTED = 0

Deprecated:

Use Widget Constants instead!

Definition at line 16 of file sorter.cls.php.

const Sorter::DONT_INDEX_SORTED = 1

Deprecated:

Use Widget Constants instead!

Definition at line 12 of file sorter.cls.php.

---

The documentation for this class was generated from the following file:

• gyro/core/controller/tools/sorter.cls.php