1. class
  2. Windwalker
  3. Form
  4. Form

Form

class Form implements IteratorAggregate (View source)

The Form class.

Methods

__construct(string $control = '')

Class init.

Form
loadXml(string|SimpleXMLElement $xml)

load

Form
loadFile(string $file)

loadFile

Form
addFields(Traversable|SimpleXMLElement $fields, string $fieldset = null, string $group = null)

addFields

AbstractField|ListField
add(string $name, AbstractField|string $field = null, string $fieldset = null, string $group = null)

Add a field.

AbstractField|ListField
addField(string|AbstractField|SimpleXMLElement $field, string $fieldset = null, string $group = null)

addField

Form
wrap(string $fieldset, string $group, Closure $handler)

wrap

Form
fieldset(string $fieldset, Closure $handler)

fieldset

Form
group(string $group, Closure $handler)

group

Form
addFieldNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Form
addFilterNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Form
addValidatorNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Iterator|AbstractField[]
getIterator()

Retrieve an external iterator

CallbackFilterIterator|AbstractField[]
getCallbackIterator(Closure $handler)

getCallbackIterator

AbstractField
getField(string $name, string $group = '')

getField

$this
removeField(string $name, string $group = null)

removeField

$this
removeFields(string $fieldset = null, string $group = null)

removeField

AbstractField[]
getFields(string $fieldset = null, string $group = null)

getFields

array
getFieldsets()

Method to get property Fieldsets

array
getGroups()

Method to get property Groups

Form
setAttribute(string $field, string $name, mixed $value, string $group = null)

setAttribute

mixed
getAttribute(string $field, string $name, mixed $default = null, string $group = null)

getAttribute

Form
setAttributes(string $name, mixed $value, string $fieldset = null, string $group = null)

setAttributes

Form
appendAttributes(string $name, mixed $value, string $fieldset = null, string $group = null)

appendAttributes

Form
bind(array $data)

bind

Form
clearValues()

reset

Form
reset()

reset

Form
filter()

filter

boolean
validate()

validate

array
getViews(string $fieldset = null, string $group = null)

getViews

void
prepareStore(string $fieldset = null, string $group = null)

prepareStore

string
renderField(string $name, string $group = '')

renderField

string
renderFields(string $fieldset = null, string $group = null)

renderFields

string
getControl()

Method to get property Control

Form
setControl(string $control)

Method to set property control

$this
defineFormFields(FieldDefinitionInterface $fields)

defineFormFields

ValidateResult[]
getErrors()

Method to get property Errors

Form
setErrors(ValidateResult[] $errors)

Method to set property errors

$this
getValues(string $fieldset = null, string $group = null)

getValues

FormRendererInterface
getRenderer()

Method to get property FieldRenderHandler

Form
setRenderer(FormRendererInterface $renderer = null)

Method to set property fieldRenderHandler

Details

at line line 92
__construct(string $control = '')

Class init.

Parameters

string $control

at line line 104
Form loadXml(string|SimpleXMLElement $xml)

load

Parameters

string|SimpleXMLElement $xml

Return Value

Form

at line line 127
Form loadFile(string $file)

loadFile

Parameters

string $file

Return Value

Form

at line line 143
Form addFields(Traversable|SimpleXMLElement $fields, string $fieldset = null, string $group = null)

addFields

Parameters

Traversable|SimpleXMLElement $fields
string $fieldset
string $group

Return Value

Form

at line line 168
AbstractField|ListField add(string $name, AbstractField|string $field = null, string $fieldset = null, string $group = null)

Add a field.

Parameters

string $name
AbstractField|string $field
string $fieldset
string $group

Return Value

AbstractField|ListField

at line line 201
AbstractField|ListField addField(string|AbstractField|SimpleXMLElement $field, string $fieldset = null, string $group = null)

addField

Parameters

string|AbstractField|SimpleXMLElement $field
string $fieldset
string $group

Return Value

AbstractField|ListField

at line line 248
Form wrap(string $fieldset, string $group, Closure $handler)

wrap

Parameters

string $fieldset
string $group
Closure $handler

Return Value

Form

at line line 269
Form fieldset(string $fieldset, Closure $handler)

fieldset

Parameters

string $fieldset
Closure $handler

Return Value

Form

at line line 282
Form group(string $group, Closure $handler)

group

Parameters

string $group
Closure $handler

Return Value

Form

at line line 295
Form addFieldNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Parameters

string $ns
int $priority

Return Value

Form Return self to support chaining.

at line line 310
Form addFilterNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Parameters

string $ns
int $priority

Return Value

Form Return self to support chaining.

at line line 325
Form addValidatorNamespace(string $ns, int $priority = 256)

Method to set property fieldNamespaces

Parameters

string $ns
int $priority

Return Value

Form Return self to support chaining.

at line line 337
Iterator|AbstractField[] getIterator()

Retrieve an external iterator

Return Value

Iterator|AbstractField[] An instance of an object implementing Iterator or Traversable

at line line 349
CallbackFilterIterator|AbstractField[] getCallbackIterator(Closure $handler)

getCallbackIterator

Parameters

Closure $handler

Return Value

CallbackFilterIterator|AbstractField[] An instance of an object implementing Iterator or Traversable

at line line 362
AbstractField getField(string $name, string $group = '')

getField

Parameters

string $name
string $group

Return Value

AbstractField

at line line 380
$this removeField(string $name, string $group = null)

removeField

Parameters

string $name
string $group

Return Value

$this

at line line 403
$this removeFields(string $fieldset = null, string $group = null)

removeField

Parameters

string $fieldset
string $group

Return Value

$this

at line line 429
AbstractField[] getFields(string $fieldset = null, string $group = null)

getFields

Parameters

string $fieldset
string $group

Return Value

AbstractField[]

at line line 463
array getFieldsets()

Method to get property Fieldsets

Return Value

array

at line line 473
array getGroups()

Method to get property Groups

Return Value

array

at line line 488
Form setAttribute(string $field, string $name, mixed $value, string $group = null)

setAttribute

Parameters

string $field
string $name
mixed $value
string $group

Return Value

Form

at line line 510
mixed getAttribute(string $field, string $name, mixed $default = null, string $group = null)

getAttribute

Parameters

string $field
string $name
mixed $default
string $group

Return Value

mixed

at line line 532
Form setAttributes(string $name, mixed $value, string $fieldset = null, string $group = null)

setAttributes

Parameters

string $name
mixed $value
string $fieldset
string $group

Return Value

Form

at line line 552
Form appendAttributes(string $name, mixed $value, string $fieldset = null, string $group = null)

appendAttributes

Parameters

string $name
mixed $value
string $fieldset
string $group

Return Value

Form

at line line 569
Form bind(array $data)

bind

Parameters

array $data

Return Value

Form

at line line 586
Form clearValues()

reset

Return Value

Form

at line line 601
Form reset()

reset

Return Value

Form

at line line 616
Form filter()

filter

Return Value

Form

at line line 631
boolean validate()

validate

Return Value

boolean

at line line 663
array getViews(string $fieldset = null, string $group = null)

getViews

Parameters

string $fieldset
string $group

Return Value

array

at line line 686
void prepareStore(string $fieldset = null, string $group = null)

prepareStore

Parameters

string $fieldset
string $group

Return Value

void

at line line 702
string renderField(string $name, string $group = '')

renderField

Parameters

string $name
string $group

Return Value

string

at line line 717
string renderFields(string $fieldset = null, string $group = null)

renderFields

Parameters

string $fieldset
string $group

Return Value

string

at line line 734
string getControl()

Method to get property Control

Return Value

string

at line line 746
Form setControl(string $control)

Method to set property control

Parameters

string $control

Return Value

Form Return self to support chaining.

at line line 765
$this defineFormFields(FieldDefinitionInterface $fields)

defineFormFields

Parameters

FieldDefinitionInterface $fields

Return Value

$this

at line line 777
ValidateResult[] getErrors()

Method to get property Errors

Return Value

ValidateResult[]

at line line 789
Form setErrors(ValidateResult[] $errors)

Method to set property errors

Parameters

ValidateResult[] $errors

Return Value

Form Return self to support chaining.

at line line 804
$this getValues(string $fieldset = null, string $group = null)

getValues

Parameters

string $fieldset
string $group

Return Value

$this

at line line 821
FormRendererInterface getRenderer()

Method to get property FieldRenderHandler

Return Value

FormRendererInterface

at line line 833
Form setRenderer(FormRendererInterface $renderer = null)

Method to set property fieldRenderHandler

Parameters

FormRendererInterface $renderer

Return Value

Form Return self to support chaining.