GroupList
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
No description
The total results of the query.
No description
No description
No description
Filters keyword fields by keywords (including name and description).
No description
Only return groups the user has the ability to assign.
No description
Gets the pagination object for the query.
Details
protected
executeSortBy($column, $direction = 'asc')
No description
protected
executeSanitizedSortBy($column, $direction = 'asc')
No description
executeGetResults()
No description
getResult($queryRow)
No description
debugStart()
No description
debugStop()
No description
debug()
No description
isDebugged()
No description
sortBy($field, $direction = 'asc')
No description
sortBySearchColumn(Column $column, $direction = null)
No description
getSearchByColumn()
No description
sanitizedSortBy($field, $direction = 'asc')
No description
getResults()
Returns a full array of results.
getActiveSortColumn()
No description
isActiveSortColumn($field)
No description
disableAutomaticSorting()
No description
getSortClassName($column)
No description
getSortURL($column, $dir = 'asc', $url = false)
No description
getActiveSortDirection()
No description
getQuerySortColumnParameter()
No description
getQueryPaginationPageParameter()
No description
getQuerySortDirectionParameter()
No description
setItemsPerPage($itemsPerPage)
No description
int
getItemsPerPage()
No description
int
getTotalResults()
The total results of the query.
Pagination
getPagination()
deprecated
deprecated
Deprecated – call the pagination factory directly.
setupAutomaticSorting(StickyRequest $request = null)
No description
get()
deprecated
deprecated
No description
createQuery()
No description
QueryBuilder
finalizeQuery(QueryBuilder $query)
No description
__construct(StickyRequest $req = null)
No description
StickyRequest|null
getSearchRequest()
No description
getQueryObject()
No description
deliverQueryObject()
No description
filter($field, $value, $comparison = '=')
deprecated
deprecated
No description
__clone()
No description
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
protected Pagination
createPaginationObject()
Gets the pagination object for the query.