PurgeParametersGroup
extends ParametersGroup
in package
This is the purge parameters group class.
Table of Contents
| $ids | : string | |
|---|---|---|
| $soft | : bool | |
| $type | : string | |
| $validator | : ParametersValidator | |
| setIds() | Sets a list of internal identifiers parameter for this parameters group. | : void |
| setSoft() | Sets the soft parameter for this parameters group. | : void |
| setType() | Sets the type 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() | : PurgeParametersValidator |
Properties
$ids
protected
string
$ids
$soft
protected
bool
$soft
$type
protected
string
$type
$validator
protected
ParametersValidator
$validator
Methods
setIds()
Sets a list of internal identifiers parameter for this parameters group.
public
setIds(string $ids) : void
Parameters
- $ids : string
Return values
void —setSoft()
Sets the soft parameter for this parameters group.
public
setSoft(bool $soft) : void
Parameters
- $soft : bool
Return values
void —setType()
Sets the type parameter for this parameters group.
public
setType(string $type) : void
Parameters
- $type : string
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() : PurgeParametersValidator