EmailsListTable extends AbstractSettingsListTable
in package

Tags
since
1.1.0

Table of Contents

$isLoaded  : bool
$items  : array<string|int, mixed>
$name  : string
$settings  : array<string|int, mixed>
__construct()  : mixed
display()  : mixed
displayRows()  : mixed
Only intended to use in templates. See display() method.
getColumns()  : array<string|int, mixed>
getId()  : string
hasItems()  : bool
load()  : mixed
displayColumn()  : mixed
displayOwnColumn()  : bool
displayRow()  : mixed
getSectionUrl()  : string
isEnabled()  : bool
loadItems()  : mixed

Properties

$isLoaded

protected bool $isLoaded = false
Tags
since
1.1.0

$items

protected array<string|int, mixed> $items = array()
Tags
since
1.1.0

$name

protected string $name
Tags
since
1.1.0

$settings

protected array<string|int, mixed> $settings = array()
Tags
since
1.1.0

Methods

__construct()

public __construct(string|array<string|int, mixed> $args[, array<string|int, mixed> $items = array() ]) : mixed
Parameters
$args : string|array<string|int, mixed>

Name (singular) or array of args. @param string $args['singular'] Required.

$items : array<string|int, mixed> = array()

Optional.

Tags
since
1.1.0
Return values
mixed —

display()

public display() : mixed
Tags
since
1.1.0
Return values
mixed —

displayRows()

Only intended to use in templates. See display() method.

public displayRows() : mixed
Tags
access

protected

since
1.1.0
Return values
mixed —

getColumns()

public getColumns() : array<string|int, mixed>
Tags
since
1.1.0
Return values
array<string|int, mixed> —

getId()

public getId() : string
Tags
since
1.1.0
Return values
string —

hasItems()

public hasItems() : bool
Tags
since
1.1.0
Return values
bool —

load()

public load() : mixed
Tags
since
1.1.0
Return values
mixed —

displayColumn()

protected displayColumn(string $columnName, AbstractEmail $email) : mixed
Parameters
$columnName : string
$email : AbstractEmail
Tags
since
1.1.0
Return values
mixed —

displayOwnColumn()

protected displayOwnColumn(string $columnName, mixed $item, array<string|int, mixed> $columnAtts) : bool
Parameters
$columnName : string
$item : mixed
$columnAtts : array<string|int, mixed>

Default column attributes.

Tags
since
1.1.0
Return values
bool —

False it this method does nothing and we need to call displayColumn() instead.

displayRow()

protected displayRow(mixed $item) : mixed
Parameters
$item : mixed
Tags
since
1.1.0
Return values
mixed —

getSectionUrl()

protected getSectionUrl(AbstractEmail $email) : string
Parameters
$email : AbstractEmail
Tags
since
1.1.0
Return values
string —

isEnabled()

protected isEnabled(AbstractEmail $email) : bool
Parameters
$email : AbstractEmail
Tags
since
1.5.0
Return values
bool —

loadItems()

protected loadItems() : mixed
Tags
since
1.1.0
Return values
mixed —

Search results