UserList
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
No description
Returns the total results in this item list.
Allow to modify the auto-pagination parameters and the auto-sorting parameters
No description
No description
No description
Filters by a attribute.
Magic method for setting up additional filtering by attributes.
No description
No description
No description
No description
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
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.
No description
No description
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.
Filter list by whether a user is validated or not.
No description
Filter list by user name.
Filter list by user name but as a like parameter.
Filters keyword fields by keywords (including username, email and attributes).
Filters the user list for only users within the provided group. Accepts an instance of a group object or a string group name.
Function used to check if a group join has already been set
Filters the user list for only users within at least one of the provided groups.
Filters by date added.
Filters by Group ID.
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
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()
Returns the total results in this item list.
Pagination
getPagination()
deprecated
deprecated
Deprecated – call the pagination factory directly.
setupAutomaticSorting(StickyRequest $request = null)
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
protected
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
VariableFactory
getPagerVariableFactory()
No description
PagerManagerInterface
getPagerManager()
No description
setPermissionsChecker(Closure $checker = null)
No description
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
checkPermissions($mixed)
No description
setUserInfoRepository(UserInfoRepository $value)
No description
UserInfoRepository
getUserInfoRepository()
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.
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.
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