class UserList extends AttributedItemList 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 from  ItemList
protected array $autoSortColumns

Columns in this array can be sorted via the request.

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 bool $includeInactiveUsers

Whether to include inactive users.

protected bool $includeUnvalidatedUsers

Whether to include unvalidated users.

private UserInfoRepository|null $userInfoRepository

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
setItemsPerPage($itemsPerPage)

No description

from  ItemList
int
getItemsPerPage()

No description

from  ItemList
int
getTotalResults()

Returns the total results in this item list.

getPagination() deprecated

Deprecated – call the pagination factory directly.

from  ItemList
setupAutomaticSorting(StickyRequest $request = null)

No description

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

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

No description

filterByAttribute($handle, $value, $comparison = '=')

Filters by a attribute.

__call($nm, $a)

Magic method for setting up additional filtering by attributes.

getPermissionsChecker()

No description

setPermissionsChecker(Closure $checker = null)

No description

ignorePermissions()

No description

enablePermissions()

No description

setBaseQuery()

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

setUserInfoRepository(UserInfoRepository $value)

No description

array
getResultIDs()

similar to get except it returns an array of userIDs much faster than getting a UserInfo object for each result if all you need is the user's id.

includeInactiveUsers()

No description

includeUnvalidatedUsers()

No description

filterByIsActive($isActive)

Explicitly filters by whether a user is active or not. Does this by setting "include inactive users" to true, THEN filtering them in our out. Some settings here are redundant given the default settings but a little duplication is ok sometimes.

filterByIsValidated(bool $isValidated)

Filter list by whether a user is validated or not.

sortByStatus($dir = 'asc')

No description

filterByUserName($username)

Filter list by user name.

filterByFuzzyUserName($username)

Filter list by user name but as a like parameter.

filterByKeywords($keywords)

Filters keyword fields by keywords (including username, email and attributes).

filterByGroup($group = '', bool $inGroup = true)

Filters the user list for only users within the provided group. Accepts an instance of a group object or a string group name.

checkGroupJoin()

Function used to check if a group join has already been set

filterByInAnyGroup(Group[]|Generator $groups, bool $inGroups = true)

Filters the user list for only users within at least one of the provided groups.

filterByDateAdded(string $date, $comparison = '=')

Filters by date added.

filterByGroupID($gID)

Filters by Group ID.

filterByNoGroup()

No description

sortByUserID()

No description

sortByUserName()

No description

sortByDateAdded()

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

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

getQuerySortDirectionParameter()

No description

setItemsPerPage($itemsPerPage)

No description

Parameters

$itemsPerPage

int getItemsPerPage()

No description

Return Value

int

int getTotalResults()

Returns the total results in this item list.

Return Value

int

Pagination getPagination() deprecated

deprecated

Deprecated – call the pagination factory directly.

Return Value

Pagination

setupAutomaticSorting(StickyRequest $request = null)

No description

Parameters

StickyRequest $request

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

protected getAttributeKeyClassName()

No description

filterByAttribute($handle, $value, $comparison = '=')

Filters by a attribute.

Parameters

$handle
$value
$comparison

__call($nm, $a)

Magic method for setting up additional filtering by attributes.

Parameters

$nm
$a

Exceptions

Exception

getPermissionsChecker()

No description

VariableFactory getPagerVariableFactory()

No description

Return Value

VariableFactory

PagerManagerInterface getPagerManager()

No description

Return Value

PagerManagerInterface

setPermissionsChecker(Closure $checker = null)

No description

Parameters

Closure $checker

ignorePermissions()

No description

enablePermissions()

No description

protected setBaseQuery()

No description

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

setUserInfoRepository(UserInfoRepository $value)

No description

Parameters

UserInfoRepository $value

UserInfoRepository getUserInfoRepository()

No description

Return Value

UserInfoRepository

array getResultIDs()

similar to get except it returns an array of userIDs much faster than getting a UserInfo object for each result if all you need is the user's id.

Return Value

array

$userIDs

includeInactiveUsers()

No description

includeUnvalidatedUsers()

No description

filterByIsActive($isActive)

Explicitly filters by whether a user is active or not. Does this by setting "include inactive users" to true, THEN filtering them in our out. Some settings here are redundant given the default settings but a little duplication is ok sometimes.

Parameters

$isActive

filterByIsValidated(bool $isValidated)

Filter list by whether a user is validated or not.

Parameters

bool $isValidated

sortByStatus($dir = 'asc')

No description

Parameters

$dir

filterByUserName($username)

Filter list by user name.

Parameters

$username

filterByFuzzyUserName($username)

Filter list by user name but as a like parameter.

Parameters

$username

filterByKeywords($keywords)

Filters keyword fields by keywords (including username, email and attributes).

Parameters

$keywords

filterByGroup($group = '', bool $inGroup = true)

Filters the user list for only users within the provided group. Accepts an instance of a group object or a string group name.

Parameters

$group
bool $inGroup

private checkGroupJoin()

Function used to check if a group join has already been set

filterByInAnyGroup(Group[]|Generator $groups, bool $inGroups = true)

Filters the user list for only users within at least one of the provided groups.

Parameters

Group[]|Generator $groups
bool $inGroups

Set to true to search users that are in at least in one of the specified groups, false to search users that aren't in any of the specified groups

filterByDateAdded(string $date, $comparison = '=')

Filters by date added.

Parameters

string $date
$comparison

filterByGroupID($gID)

Filters by Group ID.

Parameters

$gID

filterByNoGroup()

No description

sortByUserID()

No description

sortByUserName()

No description

sortByDateAdded()

No description