Fieldset

extends Zend\Form\Element implements Countable , IteratorAggregate , Traversable , Zend\Form\ElementInterface , Zend\Form\ElementPrepareAwareInterface , Zend\Form\FieldsetInterface , Zend\Form\FormFactoryAwareInterface

Known subclasses

Omeka\Form\ActivateForm, Omeka\Form\ConfirmForm, Omeka\Form\ForgotPasswordForm, Omeka\Form\InstallationForm, Omeka\Form\LoginForm, Omeka\Form\ModuleStateChangeForm, Omeka\Form\ResourceBatchUpdateForm, Omeka\Form\ResourceForm, Omeka\Form\ResourceTemplateForm, Omeka\Form\ResourceTemplateImportForm, Omeka\Form\ResourceTemplateReviewImportForm, Omeka\Form\SettingForm, Omeka\Form\SiteForm, Omeka\Form\SitePageForm, Omeka\Form\SiteSettingsForm, Omeka\Form\UserForm, Omeka\Form\VocabularyForm, Omeka\Form\VocabularyImportForm, Omeka\Form\VocabularyUpdateForm, Zend\Form\Form
Methods Summary
public
# __construct( null|int|string $name = NULL, array $options = array ( ) )
public
# setOptions( array|\Traversable $options )
Set options for a fieldset. Accepted options are: - use_as_base_fieldset: is this fieldset use as the base fieldset?

Overrides

Implementation of

public
# setFormFactory( Zend\Form\Factory $factory )
Compose a form factory to use when calling add() with a non-element/fieldset

Implementation of

public
# getFormFactory( )
Retrieve composed form factory Lazy-loads one if none present.
public
# add( array|\Traversable|\ElementInterface $elementOrFieldset , array $flags = array ( ) )
Add an element or fieldset $flags could contain metadata such as the alias under which to register the element or fieldset, order in which to prioritize it, etc.

todo


Implementation of

public
# has( string $elementOrFieldset )
Does the fieldset have an element/fieldset by the given name?

Implementation of

public
# get( string $elementOrFieldset )
Retrieve a named element or fieldset

Implementation of

public
# remove( string $elementOrFieldset )
Remove a named element or fieldset

Implementation of

public
# setPriority( string $elementOrFieldset , int $priority )
Set/change the priority of an element or fieldset

Implementation of

public
# getElements( )
Retrieve all attached elements Storage is an implementation detail of the concrete class.

Implementation of

public
# getFieldsets( )
Retrieve all attached fieldsets Storage is an implementation detail of the concrete class.

Implementation of

public
# setMessages( array|\Traversable $messages )
Set a hash of element names/messages to use when validation fails

Overrides

Implementation of

public
# getMessages( null|string $elementName = NULL )
Get validation error messages, if any Returns a hash of element names/messages for all elements failing validation, or, if $elementName is provided, messages for that element only.

Overrides

Implementation of

public
# prepareElement( Zend\Form\FormInterface $form )
Ensures state is ready for use. Here, we append the name of the fieldsets to every elements in order to avoid name clashes if the same fieldset is used multiple times

Implementation of

public
# populateValues( array|\Traversable $data )
Recursively populate values of attached elements and fieldsets

Implementation of

public
# count( )
Countable: return count of attached elements/fieldsets

Implementation of

public
# getIterator( )
IteratorAggregate: return internal iterator

Implementation of

public
# setObject( object $object )
Set the object used by the hydrator

Implementation of

public
# getObject( )
Get the object used by the hydrator

Implementation of

public
# setAllowedObjectBindingClass( string $allowObjectBindingClass )
Set the class or interface of objects that can be bound to this fieldset.
public
# allowedObjectBindingClass( )
Get The class or interface of objects that can be bound to this fieldset.
public
# allowObjectBinding( object $object )
Checks if the object can be set in this fieldset

Implementation of

public
# setHydrator( Zend\Hydrator\HydratorInterface $hydrator )
Set the hydrator to use when binding an object to the element

Implementation of

public
# getHydrator( )
Get the hydrator used when binding an object to the fieldset If no hydrator is present and object implements HydratorAwareInterface, hydrator will be retrieved from the object. Will lazy-load Hydrator\ArraySerializable if none is present.

Implementation of

public
# allowValueBinding( )
Checks if this fieldset can bind data

Implementation of

public
# bindValues( array $values = array ( ), array $validationGroup = NULL )
Bind values to the bound object

Implementation of

public
# setUseAsBaseFieldset( bool $useAsBaseFieldset )
Set if this fieldset is used as a base fieldset
public
# useAsBaseFieldset( )
Is this fieldset use as a base fieldset for a form ?
protected
# extract( )
Extract values from the bound object
public
# __clone( )
Make a deep clone of a fieldset
Methods inherited from Zend\Form\Element
__construct(), init(), setName(), getName(), setOptions(), getOptions(), getOption(), setOption(), setAttribute(), getAttribute(), removeAttribute(), hasAttribute(), setAttributes(), getAttributes(), removeAttributes(), clearAttributes(), setValue(), getValue(), setLabel(), getLabel(), setLabelAttributes(), getLabelAttributes(), setLabelOptions(), getLabelOptions(), clearLabelOptions(), removeLabelOptions(), setLabelOption(), getLabelOption(), removeLabelOption(), hasLabelOption(), setMessages(), getMessages()
Properties Summary
protected Zend\Form\Factory $factory
# NULL
protected array $elements
# array ( )
protected array $fieldsets
# array ( )
protected array $messages
# array ( )
protected Zend\Stdlib\PriorityList $iterator
# NULL
protected Zend\Hydrator\HydratorInterface $hydrator
Hydrator to use with bound object
# NULL
protected null|object $object
The object bound to this fieldset, if any
# NULL
protected bool $useAsBaseFieldset
Should this fieldset be used as a base fieldset in the parent form ?
# false
protected string $allowedObjectBindingClass
The class or interface of objects that can be bound to this fieldset.
# NULL
Properties inherited from Zend\Form\Element
$attributes, $label, $labelAttributes, $labelOptions, $messages, $options, $value