MemberListManager
extends Instanceable
in package
Member list providers manager. Provides a way to register and retrieve member list providers.
Tags
Table of Contents
Properties
- $_instances : array<class-string, static>
- Stores instances of classes with their class name as key.
- $_lists : array<string|int, mixed>
- $_metadata_providers : array<string|int, Closure>
Methods
- allEnabledLists() : array<string|int, MemberListProvider>
- Return all enabled lists.
- allLists() : array<string|int, MemberListProvider>
- Return all lists, including disabled ones.
- getInstance() : static
- Get or make an instance of the class this was called on.
- getList() : MemberListProvider
- Get a member list provider with the given name, or create an instance of GroupMemberListProvider if the name is a group ID.
- getMemberMetadata() : array<string|int, mixed>
- Get the metadata for a given user. Pipes the user through all registered metadata providers.
- listExists() : bool
- Determine whether a list with the given name exists.
- registerListProvider() : void
- Register a member list provider.
- registerMemberMetadataProvider() : void
- Register a member metadata provider.
Properties
$_instances
Stores instances of classes with their class name as key.
private
static array<class-string, static>
$_instances
= []
$_lists
private
array<string|int, mixed>
$_lists
= []
$_metadata_providers
private
array<string|int, Closure>
$_metadata_providers
= []
Methods
allEnabledLists()
Return all enabled lists.
public
allEnabledLists() : array<string|int, MemberListProvider>
Return values
array<string|int, MemberListProvider> —All enabled lists
allLists()
Return all lists, including disabled ones.
public
allLists() : array<string|int, MemberListProvider>
Return values
array<string|int, MemberListProvider> —All lists
getInstance()
Get or make an instance of the class this was called on.
public
final static getInstance() : static
Return values
static —Instance of the class this was called on.
getList()
Get a member list provider with the given name, or create an instance of GroupMemberListProvider if the name is a group ID.
public
getList(string $name[, bool $for_group = false ]) : MemberListProvider
Parameters
- $name : string
-
The name of the list, or the group ID if
$for_groupis true - $for_group : bool = false
-
Whether the name is a group ID
Tags
Return values
MemberListProvider —The member list provider with the given name
getMemberMetadata()
Get the metadata for a given user. Pipes the user through all registered metadata providers.
public
getMemberMetadata(User $user) : array<string|int, mixed>
Parameters
- $user : User
-
The user to get the metadata for
Return values
array<string|int, mixed> —The metadata for the given user
listExists()
Determine whether a list with the given name exists.
public
listExists(string $name) : bool
Parameters
- $name : string
-
The name of the list
Return values
bool —Whether a list with the given name exists
registerListProvider()
Register a member list provider.
public
registerListProvider(MemberListProvider $provider) : void
Parameters
- $provider : MemberListProvider
-
The member list provider to register
registerMemberMetadataProvider()
Register a member metadata provider.
public
registerMemberMetadataProvider(Closure $provider) : void
Member metadata providers are used to add additional information to member lists under each member's name.
Parameters
- $provider : Closure
-
The member metadata provider to register