GroupList
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
No description
The total results of the query.
Allow to modify the auto-pagination parameters and the auto-sorting parameters
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.
Only return groups the user is actually a member of
No description
No description
Gets the pagination object for the query.
No description
No description
Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter
No description
No description
No description
No description
No description
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
        
                            array
    getAutoSortColumns()
        
    
    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
        
                    protected        
    loadQueryStringPagingVariable()
        
    
    Get paging parameter from Concrete configuration
        
                            
    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.
        
                            
    performAutomaticSorting(StickyRequest $request = null)
        
    
    No description
        
                    protected        
    setupAutomaticSorting()
        
    
    No description
        
                            
    get()
        deprecated
    
    deprecated
No description
        
                            
    setNameSpace(mixed $nameSpace)
        
    
    Allow to modify the auto-pagination parameters and the auto-sorting parameters
        
                            
    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
        
                    protected        
    ensureSelected($field)
        
    
    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.
        
                            
    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
        
                    protected        Pagination
    createPaginationObject()
        
    
    Gets the pagination object for the query.
        
                            PagerManagerInterface
    getPagerManager()
        
    
    No description
        
                            VariableFactory
    getPagerVariableFactory()
        
    
    No description
        
                            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
        
                            GroupRepository
    getGroupRepository()
        
    
    No description