Class UserList

Concrete\Core\Search\ItemList\ItemList
Extended by Concrete\Core\Search\ItemList\Database\ItemList
Extended by Concrete\Core\Search\ItemList\Database\AttributedItemList
Extended by Concrete\Core\User\UserList
Namespace: Concrete\Core\User
Located at src/User/UserList.php

Methods summary

protected
public integer
# getTotalResults( )

The total results of the query

protected Concrete\Core\Search\Pagination\Pagination
# createPaginationObject( )

Gets the pagination object for the query.

public Concrete\Core\User\UserInfo
# getResult( $queryRow )
public 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

public
public Doctrine\DBAL\Query\QueryBuilder
# finalizeQuery( Doctrine\DBAL\Query\QueryBuilder $query )
public
public
public
# 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.

public
# filterByUserName( $username )

Filter list by user name

public
# filterByFuzzyUserName( $username )

Filter list by user name but as a like parameter

public
# filterByKeywords( $keywords )

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

public
# filterByGroup( Group $group = '', boolean $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

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

Filters by date added

public
# filterByGroupID( $gID )

Filters by Group ID

public
public
public
public

Properties summary

protected array $autoSortColumns

Columns in this array can be sorted via the request.

# array( 'u.uName', 'u.uEmail', 'u.uDateAdded', 'u.uLastLogin', 'u.uNumLogins', 'u.uLastOnline' )
protected boolean $includeInactiveUsers

Whether to include inactive users.

# false
protected boolean $includeUnvalidatedUsers

Whether to include unvalidated users.

# false