Documentation

Format
in package

An abstract base class and interface for ParamGroup formatting classes.

Table of Contents

$group  : mixed
$params  : mixed
__construct()  : mixed
Build a new formatting plugin.
render()  : string
A method to actually render the ParamGroup.
update_layout()  : mixed
A method to update the layout when a Param is added.
initialize_layout()  : mixed
A method to set up the default layout.

Properties

Methods

__construct()

Build a new formatting plugin.

public __construct(Params $params, ParamGroup $group[, array<string|int, mixed> $opts = [] ]) : mixed
Parameters
$params : Params

The Params object at the top of the hiearchy.

$group : ParamGroup

The ParamGroup this is being used by.

$opts : array<string|int, mixed> = []

(Optional) Any extra plugin-specific options.

Return values
mixed —

render()

A method to actually render the ParamGroup.

public abstract render() : string
Return values
string —

The rendered output representing the group help text.

update_layout()

A method to update the layout when a Param is added.

public abstract update_layout(Param $param) : mixed
Parameters
$param : Param

The Param object being added.

Return values
mixed —

initialize_layout()

A method to set up the default layout.

protected abstract initialize_layout(array<string|int, mixed> $opts) : mixed
Parameters
$opts : array<string|int, mixed>

The $opts passed to the constructor.

Return values
mixed —

Search results