Constants

EVENT_IS_VALID

EVENT_IS_VALID

EVENT_PREPARE

EVENT_PREPARE

Properties

$renderMode

$renderMode : string

Which representation to render.

Type

string

$displayMode

$displayMode : string

Hint, which representation to show in view

Type

string

$params

$params : array

Form parameters.

An array of key => value pairs which are rendered as hidden fields.

Type

array

$parent

$parent : \Zend\Form\Form

Type

\Zend\Form\Form

$isDescriptionsEnabled

$isDescriptionsEnabled : bool

Flag, if descriptions handling is enabled or not.

Type

bool

$baseFieldset

$baseFieldset

$label

$label

label of the Title and Location Form.

Methods

setRenderMode()

setRenderMode( $mode) : self

Sets the mode the form should be rendered in.

Parameters

$mode

Returns

self

getRenderMode()

getRenderMode() : string

Gets the mode the form should be rendered in.

Returns

string

setDisplayMode()

setDisplayMode( $mode) : self

Sets the mode the form should be initially displayed.

Parameters

$mode

Returns

self

getDisplayMode()

getDisplayMode() : string

Gets the mode the form should be initially displayed.

Returns

string

isValid()

isValid()

{@inheritDoc} Rebinds the bound object or sets data to the filtered values.

setOptions()

setOptions(array|\Traversable $options) : $this

Parameters

array|\Traversable $options

Returns

$this

init()

init()

{@inheritDoc}

add()

add(array|\Traversable|\Zend\Form\ElementInterface $elementOrFieldset, array $flags) : $this

Parameters

array|\Traversable|\Zend\Form\ElementInterface $elementOrFieldset
array $flags

Returns

$this

setIsDescriptionsEnabled()

setIsDescriptionsEnabled(bool $flag) : $this

Sets the descriptions enabled flag

Parameters

bool $flag

Returns

$this

isDescriptionsEnabled()

isDescriptionsEnabled() : bool

Returns the state of description awareness.

Returns

bool

setDescription()

setDescription(string $description,  $params) : $this

Sets the description for this form.

.

Parameters

string $description
$params

Returns

$this

setIsDisableCapable()

setIsDisableCapable(bool $flag) : $this

Parameters

bool $flag

Returns

$this

isDisableCapable()

isDisableCapable() : bool

Returns

bool

setIsDisableElementsCapable()

setIsDisableElementsCapable(bool $flag) : $this

Sets if this element is capable of disabling its children.

Parameters

bool $flag

Returns

$this

isDisableElementsCapable()

isDisableElementsCapable() : bool

Gets if this element is capable of disabling its children.

Returns

bool

disableElements()

disableElements(array $map) : $this

Disables elements.

To disable elements pass the element names as array entries. To disable elements inside a fieldset/form, pass the fieldset/form name as key and the element names in an array. This can be done recursively.

Parameters

array $map

Returns

$this

getHydrator()

getHydrator() : \Zend\Hydrator\HydratorInterface

Returns

\Zend\Hydrator\HydratorInterface

setParams()

setParams(array $params) : self

Sets many form parameters at once.

Parameters

array $params

Returns

self

setParam()

setParam(string $key, string $value) : self

Sets a form parameter.

Parameters

string $key
string $value

Returns

self

addClass()

addClass(mixed $spec) : $this

Parameters

mixed $spec

Returns

$this

getFormName()

getFormName()

setParent()

setParent( $parent)

Parameters

$parent

getParent()

getParent()

hasParent()

hasParent()

attachInputFilterDefaults()

attachInputFilterDefaults(\Zend\InputFilter\InputFilterInterface $inputFilter, \Zend\Form\FieldsetInterface $fieldset)

reassurance, that no required inputFilter is set on a non-existing field, this mistake is otherwise hard to detect there is still a lot to do on this issue

Parameters

\Zend\InputFilter\InputFilterInterface $inputFilter
\Zend\Form\FieldsetInterface $fieldset

Throws

\RuntimeException

prepare()

prepare()

getInputFilterSpecification()

getInputFilterSpecification()

addButtonsFieldset()

addButtonsFieldset()

Adds the buttons fieldset.

addBaseFieldset()

addBaseFieldset()

Adds the base fieldset.

addHydratorStrategies()

addHydratorStrategies(\Zend\Hydrator\HydratorInterface $hydrator)

Adds hydrator strategies to the default hydrator upon instanciation.

Parameters

\Zend\Hydrator\HydratorInterface $hydrator