ParameterHolder
ParameterHolder provides a base class for managing parameters.
Synopsis
Section titled “Synopsis”class ParameterHolder implements ResetInterface
| Implements | ResetInterface |
| Since | 1.0.0 |
| Source | Util/ParameterHolder.php |
Constructor
Section titled “Constructor”__construct()
Section titled “__construct()”public function __construct(array<int|string, mixed> $parameters = []): mixed
Constructor.
An array of parameters to be set right away.
| Parameter | Type | Description |
|---|---|---|
$parameters | `array<int“ | string, mixed>` |
Returns mixed
Methods
Section titled “Methods”| Method | Description |
|---|---|
| [`appendParameter(int | string $name, mixed $value): void`](#appendparameter) |
| [`appendParameterByRef(int | string $name, mixed &$value): void`](#appendparameterbyref) |
clearParameters(): void | Clear all parameters associated with this request. |
getFlatParameterNames(): array<int, string> | Retrieve an array of flattened parameter names. |
| [`getParameter(int | string $name, mixed $default = null): mixed`](#getparameter) |
| [`getParameterNames(): array<int, int | string>`](#getparameternames) |
| [`getParameters(): array<int | string, mixed>`](#getparameters) |
| [`hasParameter(int | string $name): bool`](#hasparameter) |
| [`removeParameter(int | string $name): mixed`](#removeparameter) |
reset(): void | Removes every parameter held, leaving the holder empty for reuse. |
| [`setParameter(int | string $name, mixed $value): void`](#setparameter) |
| [`setParameterByRef(int | string $name, mixed &$value): void`](#setparameterbyref) |
| [`setParameters(array<int | string, mixed> $parameters): void`](#setparameters) |
| [`setParametersByRef(array<int | string, mixed> &$parameters): void`](#setparametersbyref) |
appendParameter()
Section titled “appendParameter()”public function appendParameter(int|string $name, mixed $value): void
Append a parameter.
A parameter value.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
$value | mixed | A parameter value. |
appendParameterByRef()
Section titled “appendParameterByRef()”public function appendParameterByRef(int|string $name, mixed &$value): void
Append a parameter by reference.
A reference to a parameter value.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
$value | mixed | A reference to a parameter value. |
clearParameters()
Section titled “clearParameters()”public function clearParameters(): void
Clear all parameters associated with this request.
getFlatParameterNames()
Section titled “getFlatParameterNames()”public function getFlatParameterNames(): array<int, string>
Retrieve an array of flattened parameter names.
This means when a parameter is an array you wont get the name of the parameter in the result but instead all child keys appended to the name (like foo[0],foo[1][0], …)
Returns array``<``int``, ``string``> — An indexed array of parameter names.
getParameter()
Section titled “getParameter()”public function getParameter(int|string $name, mixed $default = null): mixed
Retrieve a parameter.
A default parameter value.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
$default | mixed | A default parameter value. |
Returns mixed — A parameter value, if the parameter exists, otherwise null.
getParameterNames()
Section titled “getParameterNames()”public function getParameterNames(): array<int, int|string>
Retrieve an array of parameter names.
Returns array``<``int``, ``int``|``string``> — An indexed array of parameter names.
getParameters()
Section titled “getParameters()”public function getParameters(): array<int|string, mixed>
Retrieve an array of parameters.
Returns array``<``int``|``string``, ``mixed``> — An associative array of parameters.
hasParameter()
Section titled “hasParameter()”public function hasParameter(int|string $name): bool
Indicates whether or not a parameter exists.
A parameter name.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
Returns bool — true, if the parameter exists, otherwise false.
removeParameter()
Section titled “removeParameter()”public function removeParameter(int|string $name): mixed
Remove a parameter.
A parameter name.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
Returns mixed — A parameter value, if the parameter was removed, otherwise null.
reset()
Section titled “reset()”public function reset(): void
Removes every parameter held, leaving the holder empty for reuse.
setParameter()
Section titled “setParameter()”public function setParameter(int|string $name, mixed $value): void
Set a parameter.
A parameter value.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
$value | mixed | A parameter value. |
setParameterByRef()
Section titled “setParameterByRef()”public function setParameterByRef(int|string $name, mixed &$value): void
Set a parameter by reference.
A reference to a parameter value.
| Parameter | Type | Description |
|---|---|---|
$name | `int“ | “string` |
$value | mixed | A reference to a parameter value. |
setParameters()
Section titled “setParameters()”public function setParameters(array<int|string, mixed> $parameters): void
Set an array of parameters.
An associative array of parameters and their associated values.
| Parameter | Type | Description |
|---|---|---|
$parameters | `array<int“ | string, mixed>` |
setParametersByRef()
Section titled “setParametersByRef()”public function setParametersByRef(array<int|string, mixed> &$parameters): void
Set an array of parameters by reference.
An associative array of parameters and references to their associated values.
| Parameter | Type | Description |
|---|---|---|
$parameters | `array<int“ | string, mixed>` |