Sorter Class Reference

Inheritance diagram for Sorter:

Collaboration diagram for Sorter:

Public Member Functions
	__construct (array $fields=null, bool $remember=false)
	addField (string $field, string $direction='asc')
	render ()
	removeField (string $field)
Public Member Functions inherited from DataComponent
	init (DataTable $dataTable)
	remember ()
	forget ()
	transformData ()
	getName ()
	render ()

Data Fields
const	SORTING_SEPARATOR = '~'
const	COLUMN_SEPARATOR = '.'

Protected Member Functions
	_shapeData ()
	_readFromSession ()
	_storeInSession ()
Protected Member Functions inherited from DataComponent
	_readFromSession ()
	_afterInit ()
	_storeInSession ()
	_shapeData ()

Additional Inherited Members
Protected Attributes inherited from DataComponent
	$_rememberState = false
	$_rememberKey = 'global'
	$_dataTable

Constructor & Destructor Documentation

__construct()

__construct	(	array	$fields = null,
		bool	$remember = false
	)

Sorter constructor.

Parameters

null | array	$fields
bool	$remember

Member Function Documentation

_shapeData()

_shapeData ( )

protected

Returns

Builder

addField()

addField	(	string	$field,
		string	$direction = 'asc'
	)

Sort by this column.

Parameters

string	$field
string	$direction

Returns

Sorter

removeField()

removeField

(

string

$field

)

Stop sorting by this column

Parameters

string

$field

Returns

Sorter

render()

render

(

)

Returns

string

---

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

• C:/Users/chrom/_PAGES/PackageDev/packages/hamburgscleanest/DataTables/src/Models/DataComponents/Sorter.php