PluginDataParametersGroup
extends ParametersGroup
in package
This is the plugin data parameters group class.
Tags
Table of Contents
| $action | : string | |
|---|---|---|
| $data | : array<string|int, mixed> | |
| $validator | : ParametersValidator | |
| getAction() | Returns the action value. | : string |
| setAction() | Sets the action parameter for this parameters group. | : void |
| setData() | Sets the data parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : PluginDataParametersValidator |
Properties
$action
protected
string
$action
$data
protected
array<string|int, mixed>
$data
$validator
protected
ParametersValidator
$validator
Methods
getAction()
Returns the action value.
public
getAction() : string
Return values
string —setAction()
Sets the action parameter for this parameters group.
public
setAction(string $action) : void
Parameters
- $action : string
Return values
void —setData()
Sets the data parameter for this parameters group.
public
setData(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : PluginDataParametersValidator