Documentation

FlexDirectoryForm

in package

• Grav
• Framework
• Flex

implements FlexDirectoryFormInterface, JsonSerializable uses NestedArrayAccessWithGetters, FormTrait

Class FlexForm

Table of Contents

Interfaces

FlexDirectoryFormInterface

Defines Forms for Flex Objects.

JsonSerializable

Properties

$message  : string|null

$messages  : array<string|int, string>

$status  : string

$blueprint  : Blueprint

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

$directory  : FlexDirectory

$enabled  : bool

$files  : array<string|int, UploadedFileInterface>

$flash  : FormFlashInterface|null

$flashFolder  : string

$flexName  : string

$form  : array<string|int, mixed>|null

$id  : string

$name  : string

$sessionid  : string

$submitted  : bool

$uniqueid  : string

Methods

__construct()  : mixed

FlexForm constructor.

__get()  : mixed|null

__isset()  : bool

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

__set()  : void

__unserialize()  : void

__unset()  : void

disable()  : void

enable()  : void

get()  : mixed

getAction()  : string

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

Get all available form flash objects for this form.

getBlueprint()  : Blueprint

Get blueprint used in the form.

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

getData()  : Data|object

Get current data passed to the form.

getDefaultValue()  : array<string|int, mixed>|mixed|null

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

getDirectory()  : FlexDirectory

Get object associated to the form.

getError()  : string|null

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

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

getFileDeleteAjaxRoute()  : Route|null

Get route for deleting files by AJAX.

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

getFileUploadAjaxRoute()  : Route|null

Get route for uploading files by AJAX.

getFlash()  : FormFlashInterface|FlexFormFlash

Get form flash object.

getFlexType()  : string

getFormName()  : string

getId()  : string

getMediaTaskRoute()  : string

Get media task route.

getName()  : string

getNonce()  : string

getNonceAction()  : string

getNonceName()  : string

getTask()  : string

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

getUniqueId()  : string

getValue()  : mixed

Get a value from the form.

handleRequest()  : FormInterface|$this

initialize()  : $this

instance()  : FlexFormInterface

isEnabled()  : bool

isSubmitted()  : bool

isValid()  : bool

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

render()  : mixed

{@inheritdoc}

reset()  : void

set()  : $this

setId()  : void

setRequest()  : FormInterface|$this

setUniqueId()  : void

Sets unique form id.

submit()  : FormInterface|$this

validate()  : bool

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

Decode POST data

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

doSubmit()  : void

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.

setDirectory()  : $this

Note: this method clones the object.

setError()  : void

Set a single error.

setErrors()  : void

Set all errors.

setFlashLookupFolder()  : void

setName()  : 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.