PHP Trait Airship\Engine\Bolt\Orderable

Adds sorting methods to any class.

Show file Open project: paragonie/airship

Public Methods

Method	Description
getSortArgs ( string $defaultIndex, boolean $defaultDesc = false ) : array	Parse the standard sorting arguments
orderBy ( string $column, string $direction = 'ASC', array $whiteList = [], string $default = 'name' ) : string	Create an arbitrary

Protected Methods

Method	Description
sortArrayByIndex ( array &$array, string $sort = 'name', boolean $reverse = false ) : boolean	Sort a two-dimensional array by a column

Method Details

getSortArgs() public method

Parse the standard sorting arguments

public getSortArgs ( string $defaultIndex, boolean $defaultDesc = false ) : array
$defaultIndex	string
$defaultDesc	boolean
return	array

orderBy() public method

Create an arbitrary

public orderBy ( string $column, string $direction = 'ASC', array $whiteList = [], string $default = 'name' ) : string
$column	string
$direction	string
$whiteList	array
$default	string
return	string

sortArrayByIndex() protected method

Sort a two-dimensional array by a column

protected sortArrayByIndex ( array &$array, string $sort = 'name', boolean $reverse = false ) : boolean
$array	array
$sort	string
$reverse	boolean
return	boolean