\Charcoal\Ui\FormFormInterface

Defines a form.

Summary

Methods

Constants

setAction()
action()
setMethod()
method()
setL10nMode()
l10nMode()
setFormData()
addFormData()
formData()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setAction()

setAction(string  $action) : \Charcoal\Ui\Form\FormInterface

Parameters

string

$action

The form action, typically a URL.

Returns

\Charcoal\Ui\Form\FormInterface —

Chainable

action()

action() : string

Returns

string

setMethod()

setMethod(string  $method) : \Charcoal\Ui\Form\FormInterface

Parameters

string

$method

Either "post" or "get".

Returns

\Charcoal\Ui\Form\FormInterface —

Chainable

method()

method() : string

Returns

string —

Either "post" or "get"

setL10nMode()

setL10nMode(string  $mode) : \Charcoal\Ui\Form\FormGroupInterface

Parameters

string

$mode

The l10n mode.

Returns

\Charcoal\Ui\Form\FormGroupInterface —

Chainable

l10nMode()

l10nMode() : string

Returns

string

setFormData()

setFormData(array  $data) : \Charcoal\Ui\Form\FormInterface

Parameters

array

$data

The (pre-populated) form data.

Returns

\Charcoal\Ui\Form\FormInterface —

Chainable

addFormData()

addFormData(string  $key, mixed  $val) : \Charcoal\Ui\Form\FormInterface

Parameters

string	$key	The form data key, or property identifier.
mixed	$val	The form data value, for a given key.

Returns

\Charcoal\Ui\Form\FormInterface —

Chainable

formData()

formData() : array

Returns

array