Documentation

rex_extension_point
in package

Extension Point Class.

Tags
template

T

author

gharlan

psalm-taint-specialize

Table of Contents

Methods

__construct()  : mixed
getName()  : string
Returns the name.
getParam()  : mixed
Returns the param for the given key.
getParams()  : array<string, mixed>
Returns all params.
getSubject()  : T
Returns the subject.
hasParam()  : bool
Returns whether the given param exists.
isReadonly()  : bool
Returns whether the extension point is readonly.
setExtensionParams()  : void
Sets the specific params for the next extension.
setParam()  : void
Sets a param.
setSubject()  : void
Sets the subject.

Methods

__construct()

public __construct(string $name[, T $subject = null ][, array<string, mixed> $params = [] ][, bool $readonly = false ]) : mixed
Parameters
$name : string
$subject : T = null
$params : array<string, mixed> = []
$readonly : bool = false

getName()

Returns the name.

public getName() : string
Return values
string

getParam()

Returns the param for the given key.

public getParam(string $key[, mixed $default = null ]) : mixed
Parameters
$key : string
$default : mixed = null

getParams()

Returns all params.

public getParams() : array<string, mixed>
Return values
array<string, mixed>

getSubject()

Returns the subject.

public getSubject() : T
Return values
T

hasParam()

Returns whether the given param exists.

public hasParam(string $key) : bool
Parameters
$key : string
Return values
bool

isReadonly()

Returns whether the extension point is readonly.

public isReadonly() : bool
Return values
bool

setExtensionParams()

Sets the specific params for the next extension.

public setExtensionParams(array<string, mixed> $params) : void
Parameters
$params : array<string, mixed>

setParam()

Sets a param.

public setParam(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Tags
throws
rex_exception

        
On this page

Search results