An implementation of a userlist which can be filtered by role.
More...
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
◆ 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
-
◆ 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
-
◆ 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
-
◆ 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
-
◆ get_userids()
core_privacy\local\request\userlist_base::get_userids |
( |
| ) |
|
|
inherited |
Get the list of user IDs that relate to this request.
- Return values
-
◆ 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
-
◆ key()
core_privacy\local\request\userlist_base::key |
( |
| ) |
|
|
inherited |
Return the key of the current element.
- Return values
-
◆ 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 |
◆ 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
-
◆ valid()
core_privacy\local\request\userlist_base::valid |
( |
| ) |
|
|
inherited |
Check if the current position is valid.
- Return values
-
The documentation for this class was generated from the following file: