Documentation

PluginClientBuilder
in package

FinalYes

Build an instance of a PluginClient with a dynamic list of plugins.

Tags
author

Baptiste Clavié clavie.b@gmail.com

Table of Contents

Properties

$options  : array<string|int, mixed>
$plugins  : array<string|int, array<string|int, Plugin>>

Methods

addPlugin()  : self
createClient()  : PluginClient
removeOption()  : self
setOption()  : self

Properties

$options

private array<string|int, mixed> $options = []

Array of options to give to the plugin client

$plugins

private array<string|int, array<string|int, Plugin>> $plugins = []

List of plugins ordered by priority [priority => Plugin[]]).

Methods

addPlugin()

public addPlugin(Plugin $plugin[, int $priority = 0 ]) : self
Parameters
$plugin : Plugin
$priority : int = 0

Priority of the plugin. The higher comes first.

Return values
self

removeOption()

public removeOption(string $name) : self
Parameters
$name : string
Return values
self

setOption()

public setOption(string $name, mixed $value) : self
Parameters
$name : string
$value : mixed
Return values
self

        
On this page

Search results