Summary

Fully Qualified Name:

Laminas\Form\Factory

Description

Methods

Name	Description	Defined By
__construct()		Factory
configureElement()	Configure an element based on the provided specification	Factory
configureFieldset()	Configure a fieldset based on the provided specification	Factory
configureForm()	Configure a form based on the provided specification	Factory
create()	Create an element, fieldset, or form	Factory
createElement()	Create an element	Factory
createFieldset()	Create a fieldset	Factory
createForm()	Create a form	Factory
getFormElementManager()	Get form element manager	Factory
getInputFilterFactory()	Get current input filter factory	Factory
prepareAndInjectFieldsets()	Takes a list of fieldset specifications, creates the fieldsets, and injects them into the master fieldset	Factory
setFormElementManager()	Set the form element manager	Factory
setInputFilterFactory()	Set input filter factory to use when creating forms	Factory

Method Details

__construct()

Parameter Name	Type	Description
$formElementManager	\FormElementManager
$inputFilterFactory

Returns:

configureElement()

Configure an element based on the provided specification

Specification can contain any of the following:

• type: the Element class to use; defaults to \Laminas\Form\Element
• name: what name to provide the element, if any
• options: an array or Traversable object of element options
• attributes: an array or Traversable object of element attributes to assign

Parameter Name	Type	Description
$element	\ElementInterface
$spec	array|\Traversable|\ArrayAccess

Returns: \ElementInterface

configureFieldset()

Configure a fieldset based on the provided specification

Specification can contain any of the following:

• type: the Fieldset class to use; defaults to \Laminas\Form\Fieldset
• name: what name to provide the fieldset, if any
• options: an array, Traversable, or ArrayAccess object of element options
• attributes: an array, Traversable, or ArrayAccess object of element attributes to assign
• elements: an array or Traversable object where each entry is an array or ArrayAccess object containing the keys:
  • flags: (optional) array of flags to pass to FieldsetInterface::add()
  • spec: the actual element specification, per {@link configureElement()}

Parameter Name	Type	Description
$fieldset	\FieldsetInterface
$spec	array|\Traversable|\ArrayAccess

Returns: \FieldsetInterface

configureForm()

Configure a form based on the provided specification

Specification follows that of {@link configureFieldset()}, and adds the following keys:

• input_filter: input filter instance, named input filter class, or array specification for the input filter factory
• hydrator: hydrator instance or named hydrator class

Parameter Name	Type	Description
$form	\FormInterface
$spec	array|\Traversable|\ArrayAccess

Returns: \FormInterface

create()

Create an element, fieldset, or form

Introspects the 'type' key of the provided $spec, and determines what type is being requested; if none is provided, assumes the spec represents simply an element.

Parameter Name	Type	Description
$spec	array|\Traversable

Returns: \ElementInterface

createElement()

Create an element

Parameter Name	Type	Description
$spec	array

Returns: \ElementInterface

createFieldset()

Create a fieldset

Parameter Name	Type	Description
$spec	array

Returns: \FieldsetInterface

createForm()

Create a form

Parameter Name	Type	Description
$spec	array

Returns: \FormInterface

getFormElementManager()

Get form element manager

Returns: \FormElementManager

getInputFilterFactory()

Get current input filter factory

If none provided, uses an unconfigured instance.

Returns: \InputFilterFactory

prepareAndInjectFieldsets()

Takes a list of fieldset specifications, creates the fieldsets, and injects them into the master fieldset

Parameter Name	Type	Description
$fieldsets	array|\Traversable|\ArrayAccess
$masterFieldset	\FieldsetInterface
$method	string	Method

Returns: void

setFormElementManager()

Set the form element manager

Parameter Name	Type	Description
$formElementManager	\FormElementManager

Returns: $this

setInputFilterFactory()

Set input filter factory to use when creating forms

Parameter Name	Type	Description
$inputFilterFactory	\InputFilterFactory

Returns: $this