Class UserList

An object that allows a filtered list of users to be returned.

Concrete\Core\Legacy\ItemList
Extended by Concrete\Core\Legacy\DatabaseItemList
Extended by Concrete\Core\Legacy\UserList
Namespace: Concrete\Core\Legacy
Package: Files
Category: Concrete
Copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Tony Trupp tony@concrete5.org
Located at src/Legacy/UserList.php

Methods summary

public
# filterByUserName( $username )
public
# filterByKeywords( $keywords )
public
# filterByGroup( Group|string $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
# excludeUsers( $uo )
public
# filterByGroupID( $gID )
public
# filterByDateAdded( $date, $comparison = '=' )
public UserInfo[]
# get( $itemsToGet = 100, $offset = 0 )

Returns an array of userInfo objects based on current filter settings.

public array
# getUserIDs( $itemsToGet = 100, $offset = 0 )

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

Returns the total number of items found by this list

public
protected
protected
public
# __call( $nm, $a )

Properties summary

protected array $attributeFilters
# array()
protected array $autoSortColumns
# array('uName', 'uEmail', 'uDateAdded', 'uLastLogin', 'uNumLogins', 'uLastOnline')
protected integer $itemsPerPage
# 10
protected string $attributeClass
# 'UserAttributeKey'
public $showInactiveUsers
#
public integer $showInvalidatedUsers
# 0
public integer $searchAgainstEmail
# 0