tool_dataprivacy\filtered_userlist Class Reference

An implementation of a userlist which can be filtered by role. More...

Inheritance diagram for tool_dataprivacy\filtered_userlist:

Public Member Functions
	apply_expired_context_filters (array $expireduserids, array $unexpireduserids)
	Apply filters to only remove users in the expireduserids list, and to remove any who are in the unexpired list.
	count ()
	Return the number of users.
	current ()
	Return the current user.
	get_component ()
	Get the name of the component to which this userlist belongs.
	get_context ()
	Get the context for this userlist.
	get_userids ()
	Get the list of user IDs that relate to this request.
	get_users ()
	Get the complete list of user objects that relate to this request.
	key ()
	Return the key of the current element.
	next ()
	Move to the next user in the list.
	rewind ()
	Rewind to the first found user.
	valid ()
	Check if the current position is valid.

Static Public Member Functions
static	create_from_userlist (userlist $userlist)
	Create an approved userlist from a userlist.

Protected Member Functions
	add_userids (array $userids)
	Add a set of additional userids.
	set_component ($component)
	Sets the component for this userlist.
	set_userids (array $userids)
	Set the userids.

Protected Attributes
string	$component = ''
	component the frankenstyle component name.
context	$context
	The context that this userlist belongs to.
int	$iteratorposition = 0
	Current position of the iterator.

Detailed Description

An implementation of a userlist which can be filtered by role.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

add_userids()

core_privacy\local\request\userlist_base::add_userids ( array $userids )

protectedinherited

Add a set of additional userids.

Parameters

array

$userids

The list of users.

Return values

$this

apply_expired_context_filters()

tool_dataprivacy\filtered_userlist::apply_expired_context_filters	(	array	$expireduserids,
		array	$unexpireduserids )

Apply filters to only remove users in the expireduserids list, and to remove any who are in the unexpired list.

The unexpired list wins where a user is in both lists.

Parameters

int[]	$expireduserids	The list of userids for users who should be expired.
int[]	$unexpireduserids	The list of userids for those users who should not be expired.

Return values

$this

create_from_userlist()

static core_privacy\local\request\approved_userlist::create_from_userlist ( userlist $userlist )

staticinherited

Create an approved userlist from a userlist.

Parameters

userlist

$userlist

The source list

Return values

approved_userlist

The newly created approved userlist.

current()

core_privacy\local\request\userlist_base::current ( )

inherited

Return the current user.

Return values

user

get_component()

core_privacy\local\request\userlist_base::get_component ( )

inherited

Get the name of the component to which this userlist belongs.

Return values

string

the component name associated with this userlist.

get_context()

core_privacy\local\request\userlist_base::get_context ( )

inherited

Get the context for this userlist.

Return values

context

get_userids()

core_privacy\local\request\userlist_base::get_userids ( )

inherited

Get the list of user IDs that relate to this request.

Return values

int[]

get_users()

core_privacy\local\request\userlist_base::get_users ( )

inherited

Get the complete list of user objects that relate to this request.

Return values

stdClass[]

key()

core_privacy\local\request\userlist_base::key ( )

inherited

Return the key of the current element.

Return values

mixed

rewind()

core_privacy\local\request\userlist_base::rewind ( )

inherited

Rewind to the first found user.

The list of users is uniqued during the rewind. The rewind is called at the start of most iterations.

set_component()

core_privacy\local\request\userlist_base::set_component ( $component )

protectedinherited

Sets the component for this userlist.

Parameters

string

$component

the frankenstyle component name.

Return values

$this

Reimplemented in core_privacy\local\request\userlist.

set_userids()

core_privacy\local\request\userlist_base::set_userids ( array $userids )

protectedinherited

Set the userids.

Parameters

array

$userids

The list of users.

Return values

$this

valid()

core_privacy\local\request\userlist_base::valid ( )

inherited

Check if the current position is valid.

Return values

bool

---

The documentation for this class was generated from the following file:

• admin/tool/dataprivacy/classes/filtered_userlist.php