Documentation

SortableTrait

trait SortableTrait

Tags
author

Patrick Rainer rainer@datacycle.at

Table of Contents

Properties

$sort  : array<string|int, mixed>
$sortableDefaultArgs  : array<string|int, mixed>

Methods

getSort()  : array<string|int, mixed>
setSort()  : void
sortByCreatedAt()  : void
sortByModifiedAt()  : void

Properties

$sortableDefaultArgs

protected static array<string|int, mixed> $sortableDefaultArgs = ['sort' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set sort for dataCycle API request. See dataCycle Docs for full specification', 'fn' => [__CLASS__, 'sortByModifiedAt(int $ordering = SORT_ASC)', 'sortByCreatedAt(int $ordering = SORT_ASC)'], 'default' => []]]

Methods

getSort()

public getSort() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>

setSort()

public setSort(array<string|int, mixed> $sort) : void
APIYes
Parameters
$sort : array<string|int, mixed>

sortByCreatedAt()

public sortByCreatedAt([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
$ordering : int = SORT_ASC

sortByModifiedAt()

public sortByModifiedAt([int $ordering = SORT_ASC ]) : void
APIYes
Parameters
$ordering : int = SORT_ASC

        
On this page

Search results