class GroupList extends ItemList (View source)

Properties

protected $sortColumnParameter from ItemList
protected $sortDirectionParameter from ItemList
protected $paginationPageParameter from ItemList
protected $sortBy from ItemList
protected $sortByDirection from ItemList
protected $sortBySearchColumn from ItemList
protected $enableAutomaticSorting from ItemList
protected $autoSortColumns
protected $itemsPerPage from ItemList
protected $debug from ItemList
protected Pagination $pagination from ItemList
protected QueryBuilder $query from ItemList
protected StickyRequest $searchRequest from ItemList
protected $includeAllGroups

Methods

executeSortBy($column, $direction = 'asc')

No description

from ItemList
executeSanitizedSortBy($column, $direction = 'asc')

No description

from ItemList
executeGetResults()

No description

from ItemList
getResult($queryRow)

No description

debugStart()

No description

from ItemList
debugStop()

No description

from ItemList
debug()

No description

from ItemList
isDebugged()

No description

from ItemList
sortBy($field, $direction = 'asc')

No description

from ItemList
sortBySearchColumn(Column $column, $direction = null)

No description

from ItemList
getSearchByColumn()

No description

from ItemList
sanitizedSortBy($field, $direction = 'asc')

No description

from ItemList
getResults()

Returns a full array of results.

from ItemList
getActiveSortColumn()

No description

from ItemList
isActiveSortColumn($field)

No description

from ItemList
disableAutomaticSorting()

No description

from ItemList
getSortClassName($column)

No description

from ItemList
getSortURL($column, $dir = 'asc', $url = false)

No description

from ItemList
getActiveSortDirection()

No description

from ItemList
getQuerySortColumnParameter()

No description

from ItemList
from ItemList
from ItemList
setItemsPerPage($itemsPerPage)

No description

from ItemList
int
getItemsPerPage()

No description

from ItemList
int
getTotalResults()

The total results of the query.

getPagination() deprecated

Deprecated – call the pagination factory directly.

from ItemList
setupAutomaticSorting(StickyRequest $request = null)

No description

from ItemList
get() deprecated

No description

from ItemList
setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

from ItemList
createQuery()

No description

QueryBuilder
finalizeQuery(QueryBuilder $query)

No description

__construct(StickyRequest $req = null)

No description

from ItemList
getSearchRequest()

No description

from ItemList
getQueryObject()

No description

from ItemList
deliverQueryObject()

No description

from ItemList
filter($field, $value, $comparison = '=') deprecated

No description

from ItemList
ensureSelected($field)

No description

from ItemList
__clone()

No description

from ItemList
includeAllGroups()

No description

filterByKeywords($keywords)

Filters keyword fields by keywords (including name and description).

filterByPackage(Package $package)

No description

filterByExpirable()

No description

filterByAssignable()

Only return groups the user has the ability to assign.

filterByUserID($uID)

No description

createPaginationObject()

Gets the pagination object for the query.

Details

protected executeSortBy($column, $direction = 'asc')

Parameters

$column
$direction

protected executeSanitizedSortBy($column, $direction = 'asc')

Parameters

$column
$direction

executeGetResults()

getResult($queryRow)

Parameters

$queryRow

debugStart()

debugStop()

debug()

isDebugged()

sortBy($field, $direction = 'asc')

Parameters

$field
$direction

sortBySearchColumn(Column $column, $direction = null)

Parameters

Column $column
$direction

getSearchByColumn()

sanitizedSortBy($field, $direction = 'asc')

Parameters

$field
$direction

getResults()

Returns a full array of results.

getActiveSortColumn()

isActiveSortColumn($field)

Parameters

$field

disableAutomaticSorting()

getSortClassName($column)

Parameters

$column

getSortURL($column, $dir = 'asc', $url = false)

Parameters

$column
$dir
$url

getActiveSortDirection()

getQuerySortColumnParameter()

getQueryPaginationPageParameter()

getQuerySortDirectionParameter()

setItemsPerPage($itemsPerPage)

Parameters

$itemsPerPage

int getItemsPerPage()

Return Value

int

int getTotalResults()

The total results of the query.

Return Value

int

Pagination getPagination() deprecated

deprecated

Deprecated – call the pagination factory directly.

Return Value

Pagination

setupAutomaticSorting(StickyRequest $request = null)

Parameters

StickyRequest $request

get() deprecated

deprecated

setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

Parameters

mixed $nameSpace Content that will be added to the parameters

createQuery()

QueryBuilder finalizeQuery(QueryBuilder $query)

Parameters

QueryBuilder $query

Return Value

QueryBuilder

__construct(StickyRequest $req = null)

Parameters

StickyRequest $req

StickyRequest|null getSearchRequest()

Return Value

StickyRequest|null

getQueryObject()

deliverQueryObject()

filter($field, $value, $comparison = '=') deprecated

deprecated

Parameters

$field
$value
$comparison

protected ensureSelected($field)

Parameters

$field

__clone()

includeAllGroups()

filterByKeywords($keywords)

Filters keyword fields by keywords (including name and description).

Parameters

$keywords

filterByPackage(Package $package)

Parameters

Package $package

filterByExpirable()

filterByAssignable()

Only return groups the user has the ability to assign.

filterByUserID($uID)

Parameters

$uID

protected Pagination createPaginationObject()

Gets the pagination object for the query.

Return Value

Pagination