• Home
• Symfony
• Component
• Form
• Field

PHP Class Symfony\Component\Form\Field

To implement your own form fields, you need to have a thorough understanding of the data flow within a form field. A form field stores its data in three different representations: (1) the format required by the form's object (2) a normalized format for internal processing (3) the format used for display A date field, for example, may store a date as "Y-m-d" string (1) in the object. To facilitate processing in the field, this value is normalized to a DateTime object (2). In the HTML representation of your form, a localized string (3) is presented to and modified by the user. In most cases, format (1) and format (2) will be the same. For example, a checkbox field uses a Boolean value both for internal processing as for storage in the object. In these cases you simply need to set a value transformer to convert between formats (2) and (3). You can do this by calling setValueTransformer() in the configure() method. In some cases though it makes sense to make format (1) configurable. To demonstrate this, let's extend our above date field to store the value either as "Y-m-d" string or as timestamp. Internally we still want to use a DateTime object for processing. To convert the data from string/integer to DateTime you can set a normalization transformer by calling setNormalizationTransformer() in configure(). The normalized data is then converted to the displayed data as described before. Show file Open project: pmjones/php-framework-benchmarks Class Usage Examples

Protected Properties

Property	Type	Description
$locale
$taintedData

Public Methods

Method	Description
__clone ( )	Clones this field.
__construct ( $key, array $options = [] )
addError ( Symfony\Component\Form\FieldError $error, Symfony\Component\Form\PropertyPathIterator $pathIterator = null, $type = null )	Adds an error to the field.
bind ( string | array $taintedData ) : boolean	Binds POST data to the field, transforms and validates it.
getData ( ) : mixed	Returns the normalized data of the field.
getDisplayedData ( ) : string | array	Returns the data of the field as it is displayed to the user.
getErrors ( ) : array	Returns all errors
getId ( )	{@inheritDoc}
getKey ( )	{@inheritDoc}
getName ( )	{@inheritDoc}
getParent ( ) : Symfony\Component\Form\FieldInterface	Returns the parent field.
getPropertyPath ( )	{@inheritDoc}
hasErrors ( ) : boolean	Returns weather there are errors.
isBound ( ) : boolean	Returns whether the field is bound.
isDisabled ( )	{@inheritDoc}
isHidden ( ) : boolean	Returns true if the widget is hidden.
isMultipart ( )	{@inheritDoc}
isRequired ( )	{@inheritDoc}
isValid ( ) : boolean	Returns whether the field is valid.
setData ( $data )	Updates the field with default data
setKey ( $key )	{@inheritDoc}
setLocale ( $locale )	Sets the locale of this field.
setParent ( Symfony\Component\Form\FieldInterface $parent = null )	{@inheritDoc}
setPropertyPath ( $propertyPath )	{@inheritDoc}
setRequired ( $required )	{@inheritDoc}
updateFromObject ( &$objectOrArray )	{@inheritDoc}
updateObject ( &$objectOrArray )	{@inheritDoc}

Protected Methods

Method	Description
denormalize ( string $value ) : mixed	Reverse transforms a value if a normalization transformer is set.
getNormalizationTransformer ( ) : Symfony\Component\Form\ValueTransformer\ValueTransformerInterface	Returns the ValueTransformer.
getNormalizedData ( )
getTransformedData ( ) : string	Returns the data transformed by the value transformer
getValueTransformer ( ) : Symfony\Component\Form\ValueTransformer\ValueTransformerInterface	Returns the ValueTransformer.
injectLocale ( object $object )	Injects the locale into the given object, if set.
normalize ( mixed $value ) : string	Normalizes the value if a normalization transformer is set
processData ( mixed $data ) : mixed	Processes the bound reverse-transformed data.
reverseTransform ( string $value ) : mixed	Reverse transforms a value if a value transformer is set.
setNormalizationTransformer ( Symfony\Component\Form\ValueTransformer\ValueTransformerInterface $normalizationTransformer )	Sets the ValueTransformer.
setValueTransformer ( Symfony\Component\Form\ValueTransformer\ValueTransformerInterface $valueTransformer )	Sets the ValueTransformer.
transform ( mixed $value ) : string	Transforms the value if a value transformer is set.

Method Details

Property Details