Class SimpleID\Util\Forms\FormState

`extends`	`ArrayWrapper`

A wrapper around an array used to store the state of a form.

Form states are typically serialised through SimpleID\Util\SecurityToken

and then passed around

SimpleID\Util\ArrayWrapper implements ArrayAccess<string, mixed>, Countable, IteratorAggregate<string, mixed>
- SimpleID\Util\Forms\FormState

Located at core/Util/Forms/FormState.php

Methods


					
	public

__construct(array<mixed> $data = [])

Creates a new ArrayWrapper over an underlying array

$data

the underlying array


					
	public

setRequest(ArrayWrapper $request): void


					
	public

getRequest(): ArrayWrapper


					
	public

setResponse(ArrayWrapper $response): void


					
	public

getResponse(): ArrayWrapper


					
	public

encode(): array<mixed>

Encodes the data


					
	public
					static

decode(array<string, array<mixed>> $data, string $request_class = null, string $response_class = null): FormState

Decodes the data and returns a FormState

`$request_class`	the name of the class representing the request
`$response_class`	the name of the class representing the response

Methods inherited from SimpleID\Util\ArrayWrapper
`loadData(), toArray(), offsetSet(), offsetExists(), offsetUnset(), offsetGet(), __set(), count(), getIterator(), get(), exists(), set(), append(), unset(), ref(), refLimit(), splitPath()`

Constants
`public`		`REQUEST_KEY = 'rq'`	#
`public`		`RESPONSE_KEY = 'rs'`	#

Properties inherited from SimpleID\Util\ArrayWrapper
`$container`