This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_UserList

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

Concrete5_Library_ItemList
Extended by ItemList
Extended by Concrete5_Library_DatabaseItemList
Extended by DatabaseItemList
Extended by Concrete5_Model_UserList

Direct known subclasses

UserList

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 core/models/user_list.php

Methods summary

public
# filterByUserName( $username )
public
# filterByKeywords( $keywords )
public
# filterByGroup( $groupName = '', $inGroup = true )
public
# excludeUsers( $uo )
public
# filterByGroupID( $gID )
public
# filterByDateAdded( $date, $comparison = '=' )
public
# get( $itemsToGet = 100, $offset = 0 )

Returns an array of whatever objects extends this class (e.g. PageList returns a list of pages).

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