[Form] Extracted validation logic of form. Fields can now contain multiple validators

Author: Bernhard Schussek

Field.php

@@ -65,7 +65,7 @@ class Field implements FieldInterface
     private $normTransformer;
     private $clientTransformer;
     private $transformationSuccessful = true;
-    private $validator;
+    private $validators;
     private $renderer;
     private $readOnly = false;
     private $dispatcher;
@@ -74,15 +74,21 @@ class Field implements FieldInterface
     public function __construct($name, EventDispatcherInterface $dispatcher,
         RendererInterface $renderer, DataTransformerInterface $clientTransformer = null,
         DataTransformerInterface $normTransformer = null,
-        FieldValidatorInterface $validator = null, $required = false,
+        array $validators = array(), $required = false,
         $readOnly = false, array $attributes = array())
     {
+        foreach ($validators as $validator) {
+            if (!$validator instanceof FieldValidatorInterface) {
+                throw new UnexpectedTypeException($validator, 'Symfony\Component\Form\Validator\FieldValidatorInterface');
+            }
+        }
+
         $this->name = (string)$name;
         $this->dispatcher = $dispatcher;
         $this->renderer = $renderer;
         $this->clientTransformer = $clientTransformer;
         $this->normTransformer = $normTransformer;
-        $this->validator = $validator;
+        $this->validators = $validators;
         $this->required = $required;
         $this->readOnly = $readOnly;
         $this->attributes = $attributes;
@@ -276,8 +282,8 @@ public function bind($clientData)
         $event = new DataEvent($this, $clientData);
         $this->dispatcher->dispatch(Events::postBind, $event);
 
-        if ($this->validator) {
-            $this->validator->validate($this);
+        foreach ($this->validators as $validator) {
+            $validator->validate($this);
         }
     }
 

FieldBuilder.php

@@ -44,7 +44,7 @@ class FieldBuilder
 
     private $theme;
 
-    private $validator;
+    private $validators = array();
 
     private $attributes = array();
 
@@ -139,14 +139,16 @@ public function getRequired()
         return $this->required;
     }
 
-    public function setValidator(FieldValidatorInterface $validator)
+    public function addValidator(FieldValidatorInterface $validator)
     {
-        $this->validator = $validator;
+        $this->validators[] = $validator;
+
+        return $this;
     }
 
-    public function getValidator()
+    public function getValidators()
     {
-        return $this->validator;
+        return $this->validators;
     }
 
     /**
@@ -286,7 +288,7 @@ public function getInstance()
             $this->buildRenderer(),
             $this->getClientTransformer(),
             $this->getNormTransformer(),
-            $this->getValidator(),
+            $this->getValidators(),
             $this->getRequired(),
             $this->getReadOnly(),
             $this->getAttributes()

Form.php

@@ -57,14 +57,14 @@ class Form extends Field implements \IteratorAggregate, FormInterface
      * Contains the names of bound values who don't belong to any fields
      * @var array
      */
-    private $extraFields = array();
+    private $extraData = array();
 
     private $dataMapper;
 
     public function __construct($name, EventDispatcherInterface $dispatcher,
         RendererInterface $renderer, DataTransformerInterface $clientTransformer = null,
         DataTransformerInterface $normalizationTransformer = null,
-        DataMapperInterface $dataMapper, FieldValidatorInterface $validator = null,
+        DataMapperInterface $dataMapper, array $validators = null,
         $required = false, $readOnly = false, array $attributes = array())
     {
         $dispatcher->addListener(array(
@@ -76,7 +76,7 @@ public function __construct($name, EventDispatcherInterface $dispatcher,
         $this->dataMapper = $dataMapper;
 
         parent::__construct($name, $dispatcher, $renderer, $clientTransformer,
-            $normalizationTransformer, $validator, $required, $readOnly,
+            $normalizationTransformer, $validators, $required, $readOnly,
             $attributes);
     }
 
@@ -177,13 +177,13 @@ public function filterBoundClientData(FilterDataEvent $event)
             }
         }
 
-        $this->extraFields = array();
+        $this->extraData = array();
 
         foreach ($data as $name => $value) {
             if ($this->has($name)) {
                 $this->fields[$name]->bind($value);
             } else {
-                $this->extraFields[] = $name;
+                $this->extraData[$name] = $value;
             }
         }
 
@@ -195,15 +195,9 @@ public function filterBoundClientData(FilterDataEvent $event)
         $event->setData($data);
     }
 
-    /**
-     * Returns whether this form was bound with extra fields
-     *
-     * @return Boolean
-     */
-    public function isBoundWithExtraFields()
+    public function getExtraData()
     {
-        // TODO: integrate the field names in the error message
-        return count($this->extraFields) > 0;
+        return $this->extraData;
     }
 
     /**
@@ -329,33 +323,6 @@ public function bindRequest(Request $request)
         $this->bind($data);
     }
 
-    /**
-     * Returns whether the maximum POST size was reached in this request.
-     *
-     * @return Boolean
-     */
-    public function isPostMaxSizeReached()
-    {
-        if ($this->isRoot() && isset($_SERVER['CONTENT_LENGTH'])) {
-            $length = (int) $_SERVER['CONTENT_LENGTH'];
-            $max = trim(ini_get('post_max_size'));
-
-            switch (strtolower(substr($max, -1))) {
-                // The 'G' modifier is available since PHP 5.1.0
-                case 'g':
-                    $max *= 1024;
-                case 'm':
-                    $max *= 1024;
-                case 'k':
-                    $max *= 1024;
-            }
-
-            return $length > $max;
-        }
-
-        return false;
-    }
-
     /**
      * Validates the data of this form
      *

FormBuilder.php

@@ -249,7 +249,7 @@ public function getInstance()
             $this->getClientTransformer(),
             $this->getNormTransformer(),
             $this->getDataMapper(),
-            $this->getValidator(),
+            $this->getValidators(),
             $this->getRequired(),
             $this->getReadOnly(),
             $this->getAttributes()

Resources/config/validation.xml

@@ -17,16 +17,6 @@
     <property name="fields">
       <constraint name="Valid" />
     </property>
-    <getter property="boundWithExtraFields">
-      <constraint name="AssertFalse">
-        <option name="message">This form should not contain extra fields</option>
-      </constraint>
-    </getter>
-    <getter property="postMaxSizeReached">
-      <constraint name="AssertFalse">
-        <option name="message">The uploaded file was too large. Please try to upload a smaller file</option>
-      </constraint>
-    </getter>
   </class>
 
   <class name="Symfony\Component\Form\RepeatedField">

Type/CsrfType.php

@@ -33,7 +33,7 @@ public function configure(FieldBuilder $builder, array $options)
 
         $builder
             ->setData($csrfProvider->generateCsrfToken($pageId))
-            ->setValidator(new CallbackValidator(
+            ->addValidator(new CallbackValidator(
                 function (FieldInterface $field) use ($csrfProvider, $pageId) {
                     if (!$csrfProvider->isCsrfTokenValid($pageId, $field->getData())) {
                         // FIXME this error is currently not displayed

Type/FieldType.php

@@ -59,7 +59,7 @@ public function configure(FieldBuilder $builder, array $options)
             ->setData($options['data'])
             ->setRenderer(new DefaultRenderer($this->theme, $options['template']))
             ->addRendererPlugin(new FieldPlugin())
-            ->setValidator(new DelegatingValidator($this->validator));
+            ->addValidator(new DelegatingValidator($this->validator));
 
         if ($options['trim']) {
             $builder->addEventSubscriber(new TrimListener());

Type/FormType.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Form\CsrfProvider\CsrfProviderInterface;
 use Symfony\Component\Form\DataMapper\PropertyPathMapper;
 use Symfony\Component\Form\Renderer\Plugin\FormPlugin;
+use Symfony\Component\Form\Validator\FormValidator;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 class FormType extends AbstractType
@@ -32,6 +33,7 @@ public function configure(FieldBuilder $builder, array $options)
     {
         $builder->setAttribute('virtual', $options['virtual'])
             ->addRendererPlugin(new FormPlugin())
+            ->addValidator(new FormValidator())
             ->setDataClass($options['data_class'])
             ->setDataMapper(new PropertyPathMapper(
                 $options['data_class'],

Validator/FormValidator.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Validator;
+
+use Symfony\Component\Form\FieldInterface;
+use Symfony\Component\Form\FieldError;
+
+class FormValidator implements FieldValidatorInterface
+{
+    public function validate(FieldInterface $form)
+    {
+        if (count($form->getExtraData()) > 0) {
+            $form->addError(new FieldError('This form should not contain extra fields'));
+        }
+
+        if ($form->isRoot() && isset($_SERVER['CONTENT_LENGTH'])) {
+            $length = (int) $_SERVER['CONTENT_LENGTH'];
+            $max = trim(ini_get('post_max_size'));
+
+            switch (strtolower(substr($max, -1))) {
+                // The 'G' modifier is available since PHP 5.1.0
+                case 'g':
+                    $max *= 1024;
+                case 'm':
+                    $max *= 1024;
+                case 'k':
+                    $max *= 1024;
+            }
+
+            if ($length > $max) {
+                $form->addError(new FieldError('The uploaded file was too large. Please try to upload a smaller file'));
+            }
+        }
+    }
+}