[Form] Add position support

symfony · egeloen · Jan 25, 2016 · Jan 17, 2017 · Jan 17, 2017 · Jan 17, 2017
commit d26d931ac5cf756ad555d15227f1b3c8af2c6a33
diff --git a/src/Symfony/Component/Form/ButtonBuilder.php b/src/Symfony/Component/Form/ButtonBuilder.php
@@ -12,15 +12,16 @@
 namespace Symfony\Component\Form;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\Form\Exception\InvalidArgumentException;
 use Symfony\Component\Form\Exception\BadMethodCallException;
+use Symfony\Component\Form\Exception\InvalidArgumentException;
+use Symfony\Component\Form\Exception\InvalidConfigurationException;
 
 /**
  * A builder for {@link Button} instances.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
+class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface, OrderedFormConfigBuilderInterface
 {
     /**
      * @var bool
@@ -47,6 +48,11 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
      */
     private $attributes = array();
 
+    /**
+     * @var null|string|array
+     */
+    private $position;
+
     /**
      * @var array
      */
@@ -503,6 +509,28 @@ public function setAutoInitialize($initialize)
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setPosition($position)
+    {
+        if ($this->locked) {
+            throw new BadMethodCallException('The config builder cannot be modified anymore.');
+        }
+
+        if (is_string($position) && ($position !== 'first') && ($position !== 'last')) {
+            throw new InvalidConfigurationException('If you use position as string, you can only use "first" & "last".');
+        }
+
+        if (is_array($position) && !isset($position['before']) && !isset($position['after'])) {
+            throw new InvalidConfigurationException('If you use position as array, you must at least define the "before" or "after" option.');
+        }
+
+        $this->position = $position;
+
+        return $this;
+    }
+
     /**
      * Unsupported method.
      *
@@ -752,6 +780,14 @@ public function getAutoInitialize()
         return false;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getPosition()
+    {
+        return $this->position;
+    }
+
     /**
      * Unsupported method.
      *

diff --git a/src/Symfony/Component/Form/Extension/Core/Type/BaseType.php b/src/Symfony/Component/Form/Extension/Core/Type/BaseType.php
@@ -32,8 +32,10 @@ abstract class BaseType extends AbstractType
      */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
-        $builder->setDisabled($options['disabled']);
-        $builder->setAutoInitialize($options['auto_initialize']);
+        $builder
+            ->setDisabled($options['disabled'])
+            ->setAutoInitialize($options['auto_initialize'])
+            ->setPosition($options['position']);
     }
 
     /**
@@ -117,6 +119,7 @@ public function configureOptions(OptionsResolver $resolver)
             'attr' => array(),
             'translation_domain' => null,
             'auto_initialize' => true,
+            'position' => null,
         ));
 
         $resolver->setAllowedTypes('attr', 'array');

diff --git a/src/Symfony/Component/Form/FormConfigBuilder.php b/src/Symfony/Component/Form/FormConfigBuilder.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Form\Exception\BadMethodCallException;
 use Symfony\Component\Form\Exception\InvalidArgumentException;
+use Symfony\Component\Form\Exception\InvalidConfigurationException;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 use Symfony\Component\PropertyAccess\PropertyPath;
 use Symfony\Component\PropertyAccess\PropertyPathInterface;
@@ -25,7 +26,7 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class FormConfigBuilder implements FormConfigBuilderInterface
+class FormConfigBuilder implements FormConfigBuilderInterface, OrderedFormConfigBuilderInterface
 {
     /**
      * Caches a globally unique {@link NativeRequestHandler} instance.
@@ -172,6 +173,11 @@ class FormConfigBuilder implements FormConfigBuilderInterface
      */
     private $autoInitialize = false;
 
+    /**
+     * @var null|string|array
+     */
+    private $position;
+
     /**
      * @var array
      */
@@ -513,6 +519,14 @@ public function getAutoInitialize()
         return $this->autoInitialize;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getPosition()
+    {
+        return $this->position;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -831,6 +845,28 @@ public function setAutoInitialize($initialize)
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setPosition($position)
+    {
+        if ($this->locked) {
+            throw new BadMethodCallException('The config builder cannot be modified anymore.');
+        }
+
+        if (is_string($position) && ($position !== 'first') && ($position !== 'last')) {
+            throw new InvalidConfigurationException('If you use position as string, you can only use "first" & "last".');
+        }
+
+        if (is_array($position) && !isset($position['before']) && !isset($position['after'])) {
+            throw new InvalidConfigurationException('If you use position as array, you must at least define the "before" or "after" option.');
+        }
+
+        $this->position = $position;
+
+        return $this;
+    }
+
     /**
      * {@inheritdoc}
      */