ArrayTransformer
in package
implements
IFormTransformer
FinalYes
Table of Contents
Interfaces
- IFormTransformer
- Transforms the data submitted with a POST request from its PHP representation (parsedBody) to its representation in the app (formData).
Properties
- $csrf : CsrfTransformer|null
- $fieldDefaults : array<string|int, mixed>
- $fieldTransformers : array<string|int, mixed>
- $name : string|null
Methods
- __construct() : mixed
- transformSubmittedData() : array<string, mixed>
- Extract the submitted value for the given field and convert it to the app data format.
Properties
$csrf
private
CsrfTransformer|null
$csrf
= null
$fieldDefaults
private
array<string|int, mixed>
$fieldDefaults
= []
$fieldTransformers
private
array<string|int, mixed>
$fieldTransformers
$name
private
string|null
$name
= null
Methods
__construct()
public
__construct(array<string, IFormTransformer> $fieldTransformers[, CsrfTransformer|null $csrf = null ][, array<string, IDefaultCallable<string|int, mixed>> $fieldDefaults = [] ][, string|null $name = null ]) : mixed
Parameters
- $fieldTransformers : array<string, IFormTransformer>
- $csrf : CsrfTransformer|null = null
- $fieldDefaults : array<string, IDefaultCallable<string|int, mixed>> = []
-
Array that can be empty. For any of the field defined in $fieldTransformers can be associated default callable, that sets its value in case its transformer evaluates to null.
- $name : string|null = null
transformSubmittedData()
Extract the submitted value for the given field and convert it to the app data format.
public
transformSubmittedData(array<string|int, mixed> $parsedPayload, array<string|int, mixed> $uploadedFiles) : array<string, mixed>
Parameters
- $parsedPayload : array<string|int, mixed>
- $uploadedFiles : array<string|int, mixed>
Attributes
- #[Override]
Return values
array<string, mixed> —An empty array if no data was submitted, or an associate arrays of transformed submitted data mapped by $fieldTransformers keys.