PHP Class Symfony\Component\Form\FieldGroup

Author: Fabien Potencier ([email protected])
Inheritance: extends Field, implements IteratorAggregate, implements Symfony\Component\Form\FieldGroupInterface
ファイルを表示 Open project: pmjones/php-framework-benchmarks Class Usage Examples

Protected Properties

Property Type Description
$extraFields array Contains the names of bound values who don't belong to any fields
$fields array Contains all the fields of this group

Public Methods

Method Description
__clone ( ) Clones this group
add ( Symfony\Component\Form\FieldInterface $field ) Adds a new field to this group. A field must have a unique name within the group. Otherwise the existing field is overwritten.
addError ( Symfony\Component\Form\FieldError $error, Symfony\Component\Form\PropertyPathIterator $pathIterator = null, $type = null ) {@inheritDoc}
bind ( string | array $taintedData ) : boolean Binds POST data to the field, transforms and validates it.
count ( ) : integer Returns the number of form fields (implements the \Countable interface).
get ( string $key ) : Symfony\Component\Form\FieldInterface Returns the field with the given key.
getAllHiddenFields ( ) : array Returns an array of hidden fields from the current schema.
getAllVisibleFields ( ) : array Returns an array of visible fields from the current schema.
getDisplayedData ( ) Returns the data of the field as it is displayed to the user.
getFields ( ) : array Returns all fields in this group
getHiddenFields ( ) : array Returns an array of hidden fields from the current schema.
getIterator ( ) : ArrayIterator Returns the iterator for this group.
getVisibleFields ( ) : array Returns an array of visible fields from the current schema.
has ( string $key ) : boolean Returns whether a field with the given key exists.
isBoundWithExtraFields ( ) : boolean Returns whether this form was bound with extra fields
isMultipart ( ) : boolean Returns whether the field requires a multipart form.
isValid ( ) : boolean Returns whether the field is valid.
merge ( FieldGroup $group ) Merges a field group into this group. The group must have a unique name within the group. Otherwise the existing field is overwritten.
offsetExists ( string $key ) : boolean Returns true if the bound field exists (implements the \ArrayAccess interface).
offsetGet ( string $key ) : Field Returns the form field associated with the name (implements the \ArrayAccess interface).
offsetSet ( $key, $field ) Throws an exception saying that values cannot be set (implements the \ArrayAccess interface).
offsetUnset ( string $key ) Throws an exception saying that values cannot be unset (implements the \ArrayAccess interface).
remove ( string $key ) Removes the field with the given key.
setData ( $data ) Initializes the field group with an object to operate on
setLocale ( $locale ) Sets the locale of this field.

Protected Methods

Method Description
getFieldsByVisibility ( boolean $hidden, boolean $recursive ) : array Returns a filtered array of fields from the current schema.
preprocessData ( array $data ) : array Processes the bound data before it is passed to the individual fields

Method Details

__clone() public method

Clones this group
public __clone ( )

add() public method

If you add a nested group, this group should also be represented in the object hierarchy. If you want to add a group that operates on the same hierarchy level, use merge(). class Entity { public $location; } class Location { public $longitude; public $latitude; } $entity = new Entity(); $entity->location = new Location(); $form = new Form('entity', $entity, $validator); $locationGroup = new FieldGroup('location'); $locationGroup->add(new TextField('longitude')); $locationGroup->add(new TextField('latitude')); $form->add($locationGroup);
public add ( Symfony\Component\Form\FieldInterface $field )
$field Symfony\Component\Form\FieldInterface

addError() public method

{@inheritDoc}
public addError ( Symfony\Component\Form\FieldError $error, Symfony\Component\Form\PropertyPathIterator $pathIterator = null, $type = null )
$error Symfony\Component\Form\FieldError
$pathIterator Symfony\Component\Form\PropertyPathIterator

bind() public method

Binds POST data to the field, transforms and validates it.
public bind ( string | array $taintedData ) : boolean
$taintedData string | array The POST data
return boolean Whether the form is valid

count() public method

Returns the number of form fields (implements the \Countable interface).
public count ( ) : integer
return integer The number of embedded form fields

get() public method

Returns the field with the given key.
public get ( string $key ) : Symfony\Component\Form\FieldInterface
$key string
return Symfony\Component\Form\FieldInterface

getAllHiddenFields() public method

This variant of the method will recursively get all the fields from the nested forms or field groups
public getAllHiddenFields ( ) : array
return array

getAllVisibleFields() public method

This variant of the method will recursively get all the fields from the nested forms or field groups
public getAllVisibleFields ( ) : array
return array

getDisplayedData() public method

Returns the data of the field as it is displayed to the user.
See also: FieldInterface
public getDisplayedData ( )

getFields() public method

Returns all fields in this group
public getFields ( ) : array
return array

getFieldsByVisibility() protected method

Returns a filtered array of fields from the current schema.
protected getFieldsByVisibility ( boolean $hidden, boolean $recursive ) : array
$hidden boolean Whether to return hidden fields only or visible fields only
$recursive boolean Whether to recur through embedded schemas
return array

getHiddenFields() public method

Returns an array of hidden fields from the current schema.
public getHiddenFields ( ) : array
return array

getIterator() public method

Returns the iterator for this group.

getVisibleFields() public method

Returns an array of visible fields from the current schema.
public getVisibleFields ( ) : array
return array

has() public method

Returns whether a field with the given key exists.
public has ( string $key ) : boolean
$key string
return boolean

isBoundWithExtraFields() public method

Returns whether this form was bound with extra fields
public isBoundWithExtraFields ( ) : boolean
return boolean

isMultipart() public method

Returns whether the field requires a multipart form.
public isMultipart ( ) : boolean
return boolean

isValid() public method

Returns whether the field is valid.
public isValid ( ) : boolean
return boolean

merge() public method

Contrary to added groups, merged groups operate on the same object as the group they are merged into. class Entity { public $longitude; public $latitude; } $entity = new Entity(); $form = new Form('entity', $entity, $validator); $locationGroup = new FieldGroup('location'); $locationGroup->add(new TextField('longitude')); $locationGroup->add(new TextField('latitude')); $form->merge($locationGroup);
public merge ( FieldGroup $group )
$group FieldGroup

offsetExists() public method

Returns true if the bound field exists (implements the \ArrayAccess interface).
public offsetExists ( string $key ) : boolean
$key string The key of the bound field
return boolean true if the widget exists, false otherwise

offsetGet() public method

Returns the form field associated with the name (implements the \ArrayAccess interface).
public offsetGet ( string $key ) : Field
$key string The offset of the value to get
return Field A form field instance

offsetSet() public method

Throws an exception saying that values cannot be set (implements the \ArrayAccess interface).
public offsetSet ( $key, $field )

offsetUnset() public method

Throws an exception saying that values cannot be unset (implements the \ArrayAccess interface).
public offsetUnset ( string $key )
$key string

preprocessData() protected method

The data is in the user format.
protected preprocessData ( array $data ) : array
$data array
return array

remove() public method

Removes the field with the given key.
public remove ( string $key )
$key string

setData() public method

Initializes the field group with an object to operate on
See also: FieldInterface
public setData ( $data )

setLocale() public method

Sets the locale of this field.
See also: Localizable
public setLocale ( $locale )

Property Details

$extraFields protected_oe property

Contains the names of bound values who don't belong to any fields
protected array $extraFields
return array

$fields protected_oe property

Contains all the fields of this group
protected array $fields
return array