class GroupList extends ItemList implements PagerProviderInterface, PaginationProviderInterface (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
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 Closure $permissionsChecker
protected $includeAllGroups
protected GroupRepository $groupRepository

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
array
getAutoSortColumns()

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
loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

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
performAutomaticSorting(StickyRequest $request = null)

No description

from  ItemList
setupAutomaticSorting()

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.

filterByHavingMembership()

Only return groups the user is actually a member of

filterByParentGroup(Group $parent)

No description

filterByGroupType(GroupType $groupType)

No description

filterByUserID($uID)

No description

filterByName($gName)

No description

createPaginationObject()

Gets the pagination object for the query.

mixed
getPaginationAdapter()

Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter

checkPermissions($mixed)

No description

setPermissionsChecker(Closure|null $checker = null)

No description

ignorePermissions()

No description

getPermissionsChecker()

No description

enablePermissions()

No description

setGroupRepository(GroupRepository $value)

No description

Details

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

No description

Parameters

$column
$direction

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

No description

Parameters

$column
$direction

executeGetResults()

No description

getResult($queryRow)

No description

Parameters

$queryRow

debugStart()

No description

debugStop()

No description

array getAutoSortColumns()

No description

Return Value

array

debug()

No description

isDebugged()

No description

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

No description

Parameters

$field
$direction

sortBySearchColumn(Column $column, $direction = null)

No description

Parameters

Column $column
$direction

getSearchByColumn()

No description

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

No description

Parameters

$field
$direction

getResults()

Returns a full array of results.

getActiveSortColumn()

No description

isActiveSortColumn($field)

No description

Parameters

$field

disableAutomaticSorting()

No description

getSortClassName($column)

No description

Parameters

$column

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

No description

Parameters

$column
$dir
$url

getActiveSortDirection()

No description

getQuerySortColumnParameter()

No description

getQueryPaginationPageParameter()

No description

protected loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

getQuerySortDirectionParameter()

No description

setItemsPerPage($itemsPerPage)

No description

Parameters

$itemsPerPage

int getItemsPerPage()

No description

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

performAutomaticSorting(StickyRequest $request = null)

No description

Parameters

StickyRequest $request

protected setupAutomaticSorting()

No description

get() deprecated

deprecated

No description

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()

No description

QueryBuilder finalizeQuery(QueryBuilder $query)

No description

Parameters

QueryBuilder $query

Return Value

QueryBuilder

__construct(StickyRequest $req = null)

No description

Parameters

StickyRequest $req

StickyRequest|null getSearchRequest()

No description

Return Value

StickyRequest|null

getQueryObject()

No description

deliverQueryObject()

No description

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

deprecated

No description

Parameters

$field
$value
$comparison

protected ensureSelected($field)

No description

Parameters

$field

__clone()

No description

includeAllGroups()

No description

filterByKeywords($keywords)

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

Parameters

$keywords

filterByPackage(Package $package)

No description

Parameters

Package $package

filterByExpirable()

No description

filterByAssignable()

Only return groups the user has the ability to assign.

filterByHavingMembership()

Only return groups the user is actually a member of

filterByParentGroup(Group $parent)

No description

Parameters

Group $parent

filterByGroupType(GroupType $groupType)

No description

Parameters

GroupType $groupType

filterByUserID($uID)

No description

Parameters

$uID

filterByName($gName)

No description

Parameters

$gName

protected Pagination createPaginationObject()

Gets the pagination object for the query.

Return Value

Pagination

PagerManagerInterface getPagerManager()

No description

Return Value

PagerManagerInterface

VariableFactory getPagerVariableFactory()

No description

Return Value

VariableFactory

mixed getPaginationAdapter()

Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter

Return Value

mixed

checkPermissions($mixed)

No description

Parameters

$mixed

setPermissionsChecker(Closure|null $checker = null)

No description

Parameters

Closure|null $checker

ignorePermissions()

No description

getPermissionsChecker()

No description

enablePermissions()

No description

setGroupRepository(GroupRepository $value)

No description

Parameters

GroupRepository $value

GroupRepository getGroupRepository()

No description

Return Value

GroupRepository