Documentation

FormTrait uses trait:short

Trait FormTrait

Table of Contents

Properties

$message  : string|null

$messages  : array<string|int, string>

$status  : string

$blueprint  : Blueprint

$data  : ArrayAccess<string, mixed>|Data|null

$enabled  : bool

$files  : array<string|int, UploadedFileInterface>

$flash  : FormFlashInterface|null

$flashFolder  : string

$id  : string

$name  : string

$sessionid  : string

$submitted  : bool

$uniqueid  : string

Methods

__serialize()  : array<string|int, mixed>

__unserialize()  : void

disable()  : void

enable()  : void

getAction()  : string

getAllFlashes()  : array<string|int, FormFlashInterface>

Get all available form flash objects for this form.

getBlueprint()  : Blueprint

getButtons()  : array<string|int, mixed>

getData()  : mixed

getDefaultValue()  : mixed|null

getDefaultValues()  : array<string|int, mixed>

getError()  : string|null

getErrors()  : array<string|int, mixed>

getFields()  : array<string|int, mixed>

getFiles()  : array<string|int, mixed>|array<string|int, UploadedFileInterface>

getFlash()  : FormFlashInterface

Get form flash object.

getFormName()  : string

getId()  : string

getName()  : string

getNonce()  : string

getNonceAction()  : string

getNonceName()  : string

getTask()  : string

getTasks()  : array<string|int, mixed>

getUniqueId()  : string

getValue()  : mixed|null

handleRequest()  : FormInterface|$this

isEnabled()  : bool

isSubmitted()  : bool

isValid()  : bool

jsonSerialize()  : array<string|int, mixed>

render()  : mixed

{@inheritdoc}

reset()  : void

serialize()  : string

setId()  : void

setRequest()  : FormInterface|$this

setUniqueId()  : void

submit()  : FormInterface|$this

unserialize()  : void

validate()  : bool

decodeData()  : array<string|int, mixed>

Decode POST data

doSerialize()  : array<string|int, mixed>

doUnserialize()  : void

filterData()  : void

Filter validated data.

getFlashFolder()  : string|null

getFlashId()  : string|null

getFlashLookupFolder()  : string

getSessionId()  : string

getTemplate()  : Template|TemplateWrapper

getUnserializeAllowedClasses()  : array<string|int, mixed>|bool

jsonDecode()  : array<string|int, mixed>

Recursively JSON decode POST data.

parseRequest()  : array<string|int, mixed>

Parse PSR-7 ServerRequest into data and files.

setError()  : void

Set a single error.

setErrors()  : void

Set all errors.

setFlashLookupFolder()  : void

setSessionId()  : void

unsetFlash()  : void

validateData()  : void

Validate data and throw validation exceptions if validation fails.

validateUpload()  : void

Validate uploaded file.

validateUploads()  : void

Validate all uploaded files.