Documentation

StaffMembersListProvider extends MemberListProvider
in package

Base class for member list providers.

Table of Contents

Properties

$_display_on_overview  : bool
$_friendly_name  : string
$_icon  : string|null
$_module  : string
$_name  : string
$_enabled  : bool

Methods

__construct()  : mixed
displayOnOverview()  : bool
getFriendlyName()  : string
getIcon()  : string|null
getMemberCount()  : int
Determine the total number of members in this list.
getMembers()  : array<string|int, mixed>
Get an array of members to display on the member list page.
getModule()  : string
getName()  : string
isEnabled()  : bool
Determine whether the member list provider is enabled or not. Will automatically enable the member list if it is not already enabled.
url()  : string
generator()  : array<string|int, mixed>
Get the information needed to generate the member list.
filterBanned()  : array<string|int, mixed>
Filter out banned users from a list of members.

Properties

Methods

displayOnOverview()

public displayOnOverview() : bool
Return values
bool

Whether the member list provider should be displayed on the member list overview page

getFriendlyName()

public getFriendlyName() : string
Return values
string

The friendly name of the member list provider, displayed in navigation and user-facing pages

getIcon()

public getIcon() : string|null
Return values
string|null

The icon to display next to the member list provider's name in the members page navigation sidebar

getMemberCount()

Determine the total number of members in this list.

public getMemberCount() : int
Return values
int

The total number of members in this list

getMembers()

Get an array of members to display on the member list page.

public getMembers(bool $overview, int $page) : array<string|int, mixed>
Parameters
$overview : bool

Whether the member list is being displayed on the overview page. If true, only 5 members will be returned, otherwise 20.

$page : int

The page number to display, starting at 1 - pages are 20 members long

Return values
array<string|int, mixed>

An array of members to display on the member list page

getModule()

public getModule() : string
Return values
string

The name of the module that the member list provider belongs to

getName()

public getName() : string
Return values
string

The name of the member list provider. This will be used for URLs and database queries.

isEnabled()

Determine whether the member list provider is enabled or not. Will automatically enable the member list if it is not already enabled.

public isEnabled() : bool
Return values
bool

Whether the member list provider is enabled

url()

public url() : string
Return values
string

A URL to this specific member list page

generator()

Get the information needed to generate the member list.

protected generator() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array containing the SQL query to run, the column name of the user ID, and optionally the column name of the "count" value for this list. Count values are used to display the number of posts, likes, etc.

filterBanned()

Filter out banned users from a list of members.

private filterBanned(array<string|int, mixed> $rows, string $id_column) : array<string|int, mixed>
Parameters
$rows : array<string|int, mixed>

Rows returned from the member list query

$id_column : string

The name of the column in each row containing the user ID

Return values
array<string|int, mixed>

The rows with banned users filtered out


        
On this page

Search results