SortableHeader Class Reference

Inheritance diagram for SortableHeader:

Collaboration diagram for SortableHeader:

Public Member Functions
	__construct (array $sortableHeaders=[], array $dontSort=[])
	sortingSymbols (array $sortingSymbols)
	makeSortable (string $header)
	dontSort (string $header)
	format (Header $header)

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

Constructor & Destructor Documentation

__construct()

__construct	(	array	$sortableHeaders = [],
		array	$dontSort = []
	)

SortableHeader constructor.

Parameters

array	$sortableHeaders
array	$dontSort

Member Function Documentation

dontSort()

dontSort

(

string

$header

)

Remove the ability to sort by this column/header.

Parameters

string

$header

Returns

SortableHeader

format()

format

(

Header

$header

)

Adds a link to sort by this header/column. Also indicates how the columns are sorted (when sorted).

Parameters

Header

$header

Exceptions

Implements HeaderFormatter.

makeSortable()

makeSortable

(

string

$header

)

Add a field to the sortable fields.

Parameters

string

$header

Returns

SortableHeader

sortingSymbols()

sortingSymbols

(

array

$sortingSymbols

)

Parameters

array

$sortingSymbols

Returns

SortableHeader

---

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

• C:/Users/chrom/_PAGES/PackageDev/packages/hamburgscleanest/DataTables/src/Models/HeaderFormatters/SortableHeader.php