Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
core_privacy\local\request\approved_userlist Class Reference

An implementation of a userlist which has been filtered and approved. More...

Inheritance diagram for core_privacy\local\request\approved_userlist:
core_privacy\local\request\userlist_base tool_dataprivacy\filtered_userlist

Public Member Functions

 __construct (\context $context, string $component, array $userids)
 Create a new approved userlist.
 
 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 has been filtered and approved.

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

Constructor & Destructor Documentation

◆ __construct()

core_privacy\local\request\approved_userlist::__construct ( \context $context,
string $component,
array $userids )

Create a new approved userlist.

Parameters
context$contextThe context.
string$componentthe frankenstyle component name.
int[]$useridsThe list of userids present in this list.

Member Function Documentation

◆ add_userids()

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

Add a set of additional userids.

Parameters
array$useridsThe list of users.
Return values
$this

◆ create_from_userlist()

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

Create an approved userlist from a userlist.

Parameters
userlist$userlistThe source list
Return values
approved_userlistThe 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
stringthe 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$componentthe 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$useridsThe 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: