symfony · fabpot · Feb 2, 2012 · Jan 26, 2012 · Tobion · Feb 2, 2012
diff --git a/CHANGELOG-2.1.md b/CHANGELOG-2.1.md
@@ -158,6 +158,7 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
 
 ### Form
 
+ * [BC BREAK] ``read_only`` field attribute now renders as ``readonly="readonly"``, use ``disabled`` instead
  * [BC BREAK] child forms now aren't validated anymore by default
  * made validation of form children configurable (new option: cascade_validation)
  * added support for validation groups as callbacks

diff --git a/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig b/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
@@ -280,7 +280,7 @@
 
 {% block widget_attributes %}
 {% spaceless %}
-    id="{{ id }}" name="{{ full_name }}"{% if read_only %} disabled="disabled"{% endif %}{% if required %} required="required"{% endif %}{% if max_length %} maxlength="{{ max_length }}"{% endif %}{% if pattern %} pattern="{{ pattern }}"{% endif %}
+    id="{{ id }}" name="{{ full_name }}"{% if read_only %} readonly="readonly"{% endif %}{% if disabled %} disabled="disabled"{% endif %}{% if required %} required="required"{% endif %}{% if max_length %} maxlength="{{ max_length }}"{% endif %}{% if pattern %} pattern="{{ pattern }}"{% endif %}
     {% for attrname,attrvalue in attr %}{{attrname}}="{{attrvalue}}" {% endfor %}
 {% endspaceless %}
 {% endblock widget_attributes %}

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/attributes.html.php b/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/attributes.html.php
@@ -1,6 +1,7 @@
 id="<?php echo $view->escape($id) ?>"
 name="<?php echo $view->escape($full_name) ?>"
-<?php if ($read_only): ?>disabled="disabled" <?php endif ?>
+<?php if ($read_only): ?>readonly="readonly" <?php endif ?>
+<?php if ($disabled): ?>disabled="disabled" <?php endif ?>
 <?php if ($required): ?>required="required" <?php endif ?>
 <?php if ($max_length): ?>maxlength="<?php echo $view->escape($max_length) ?>" <?php endif ?>
 <?php if ($pattern): ?>pattern="<?php echo $view->escape($pattern) ?>" <?php endif ?>

diff --git a/src/Symfony/Component/Form/Extension/Core/Type/FieldType.php b/src/Symfony/Component/Form/Extension/Core/Type/FieldType.php
@@ -44,9 +44,10 @@ public function buildForm(FormBuilder $builder, array $options)
 
         $builder
             ->setRequired($options['required'])
-            ->setReadOnly($options['read_only'])
+            ->setDisabled($options['disabled'])
             ->setErrorBubbling($options['error_bubbling'])
             ->setEmptyData($options['empty_data'])
+            ->setAttribute('read_only', $options['read_only'])
             ->setAttribute('by_reference', $options['by_reference'])
             ->setAttribute('property_path', $options['property_path'])
             ->setAttribute('error_mapping', $options['error_mapping'])
@@ -102,7 +103,8 @@ public function buildView(FormView $view, FormInterface $form)
             ->set('full_name', $fullName)
             ->set('errors', $form->getErrors())
             ->set('value', $form->getClientData())
-            ->set('read_only', $form->isReadOnly())
+            ->set('read_only', $form->getAttribute('read_only'))
+            ->set('disabled', $form->isDisabled())
             ->set('required', $form->isRequired())
             ->set('max_length', $form->getAttribute('max_length'))
             ->set('pattern', $form->getAttribute('pattern'))
@@ -126,6 +128,7 @@ public function getDefaultOptions(array $options)
             'trim'              => true,
             'required'          => true,
             'read_only'         => false,
+            'disabled'          => false,
             'max_length'        => null,
             'pattern'           => null,
             'property_path'     => null,

diff --git a/src/Symfony/Component/Form/Form.php b/src/Symfony/Component/Form/Form.php
@@ -166,7 +166,7 @@ class Form implements \IteratorAggregate, FormInterface
      * Whether this form may only be read, but not bound
      * @var Boolean
      */
-    private $readOnly = false;
+    private $disabled = false;
 
     /**
      * The dispatcher for distributing events of this form
@@ -190,7 +190,7 @@ public function __construct($name, EventDispatcherInterface $dispatcher,
         array $types = array(), array $clientTransformers = array(),
         array $normTransformers = array(),
         DataMapperInterface $dataMapper = null, array $validators = array(),
-        $required = false, $readOnly = false, $errorBubbling = false,
+            $required = false, $disabled = false, $errorBubbling = false,
         $emptyData = null, array $attributes = array())
     {
         foreach ($clientTransformers as $transformer) {
@@ -219,7 +219,7 @@ public function __construct($name, EventDispatcherInterface $dispatcher,
         $this->dataMapper = $dataMapper;
         $this->validators = $validators;
         $this->required = (Boolean) $required;
-        $this->readOnly = (Boolean) $readOnly;
+        $this->disabled = (Boolean) $disabled;
         $this->errorBubbling = (Boolean) $errorBubbling;
         $this->emptyData = $emptyData;
         $this->attributes = $attributes;
@@ -266,29 +266,19 @@ public function getTypes()
     public function isRequired()
     {
         if (null === $this->parent || $this->parent->isRequired()) {
-
             return $this->required;
         }
 
         return false;
     }
 
     /**
-     * Returns whether this form is read only.
-     *
-     * The content of a read-only form is displayed, but not allowed to be
-     * modified. The validation of modified read-only forms should fail.
-     *
-     * Fields whose parents are read-only are considered read-only regardless of
-     * their own state.
-     *
-     * @return Boolean
+     * {@inheritDoc}
      */
-    public function isReadOnly()
+    public function isDisabled()
     {
-        if (null === $this->parent || !$this->parent->isReadOnly()) {
-
-            return $this->readOnly;
+        if (null === $this->parent || !$this->parent->isDisabled()) {
+            return $this->disabled;
         }
 
         return true;
@@ -457,7 +447,7 @@ public function getExtraData()
      */
     public function bind($clientData)
     {
-        if ($this->readOnly) {
+        if ($this->isDisabled()) {
             $this->bound = true;
 
             return $this;
@@ -674,7 +664,6 @@ public function isEmpty()
     {
         foreach ($this->children as $child) {
             if (!$child->isEmpty()) {
-
                 return false;
             }
         }
@@ -697,10 +686,9 @@ public function isValid()
             return false;
         }
 
-        if (!$this->readOnly) {
+        if (!$this->isDisabled()) {
             foreach ($this->children as $child) {
                 if (!$child->isValid()) {
-
                     return false;
                 }
             }
@@ -865,7 +853,6 @@ public function has($name)
     public function get($name)
     {
         if (isset($this->children[$name])) {
-
             return $this->children[$name];
         }
 

diff --git a/src/Symfony/Component/Form/FormBuilder.php b/src/Symfony/Component/Form/FormBuilder.php
@@ -46,7 +46,7 @@ class FormBuilder
     /**
      * @var Boolean
      */
-    private $readOnly;
+    private $disabled;
 
     /**
      * @var Boolean
@@ -174,27 +174,27 @@ public function getData()
     }
 
     /**
-     * Set whether the form is read only
+     * Set whether the form is disabled
      *
-     * @param Boolean $readOnly Whether the form is read only
+     * @param Boolean $disabled Whether the form is disabled
      *
      * @return FormBuilder The current builder
      */
-    public function setReadOnly($readOnly)
+    public function setDisabled($disabled)
     {
-        $this->readOnly = (Boolean) $readOnly;
+        $this->disabled = (Boolean) $disabled;
 
         return $this;
     }
 
     /**
-     * Returns whether the form is read only.
+     * Returns whether the form is disabled.
      *
-     * @return Boolean Whether the form is read only
+     * @return Boolean Whether the form is disabled
      */
-    public function getReadOnly()
+    public function getDisabled()
     {
-        return $this->readOnly;
+        return $this->disabled;
     }
 
     /**
@@ -645,7 +645,7 @@ public function getForm()
             $this->getDataMapper(),
             $this->getValidators(),
             $this->getRequired(),
-            $this->getReadOnly(),
+            $this->getDisabled(),
             $this->getErrorBubbling(),
             $this->getEmptyData(),
             $this->getAttributes()

diff --git a/src/Symfony/Component/Form/FormInterface.php b/src/Symfony/Component/Form/FormInterface.php
@@ -48,9 +48,9 @@ function add(FormInterface $child);
 
     /**
      * Returns the child with the given name.
-     * 
+     *
      * @param string $name The name of the child
-     * 
+     *
      * @return FormInterface The child form
      */
     function get($name);
@@ -178,17 +178,17 @@ function isValid();
     function isRequired();
 
     /**
-     * Returns whether this form can be read only.
+     * Returns whether this form is disabled.
      *
-     * The content of a read-only form is displayed, but not allowed to be
-     * modified. The validation of modified read-only forms should fail.
+     * The content of a disabled form is displayed, but not allowed to be
+     * modified. The validation of modified disabled forms should fail.
      *
-     * Fields whose parents are read-only are considered read-only regardless of
+     * Fields whose parents are disabled are considered disabled regardless of
      * their own state.
      *
      * @return Boolean
      */
-    function isReadOnly();
+    function isDisabled();
 
     /**
      * Returns whether the form is empty.

diff --git a/tests/Symfony/Tests/Component/Form/AbstractLayoutTest.php b/tests/Symfony/Tests/Component/Form/AbstractLayoutTest.php
@@ -1299,6 +1299,36 @@ public function testHidden()
         );
     }
 
+    public function testReadOnly()
+    {
+        $form = $this->factory->createNamed('text', 'name', null, array(
+            'read_only' => true,
+        ));
+
+        $this->assertWidgetMatchesXpath($form->createView(), array(),
+'/input
+    [@type="text"]
+    [@name="name"]
+    [@readonly="readonly"]
+'
+        );
+    }
+
+    public function testDisabled()
+    {
+        $form = $this->factory->createNamed('text', 'name', null, array(
+            'disabled' => true,
+        ));
+
+        $this->assertWidgetMatchesXpath($form->createView(), array(),
+'/input
+    [@type="text"]
+    [@name="name"]
+    [@disabled="disabled"]
+'
+        );
+    }
+
     public function testInteger()
     {
         $form = $this->factory->createNamed('integer', 'na&me', 123, array(

diff --git a/tests/Symfony/Tests/Component/Form/Extension/Core/Type/FieldTypeTest.php b/tests/Symfony/Tests/Component/Form/Extension/Core/Type/FieldTypeTest.php
@@ -70,11 +70,11 @@ public function testPassRequiredAsOption()
         $this->assertTrue($form->isRequired());
     }
 
-    public function testPassReadOnlyAsOption()
+    public function testPassDisabledAsOption()
     {
-        $form = $this->factory->create('field', null, array('read_only' => true));
+        $form = $this->factory->create('field', null, array('disabled' => true));
 
-        $this->assertTrue($form->isReadOnly());
+        $this->assertTrue($form->isDisabled());
     }
 
     public function testBoundDataIsTrimmedBeforeTransforming()

diff --git a/tests/Symfony/Tests/Component/Form/FormFactoryTest.php b/tests/Symfony/Tests/Component/Form/FormFactoryTest.php
@@ -492,7 +492,7 @@ public function testUnknownOptions()
 
         $this->setExpectedException('Symfony\Component\Form\Exception\CreationException',
             'The options "invalid", "unknown" do not exist. Known options are: "data", "data_class", ' .
-            '"trim", "required", "read_only", "max_length", "pattern", "property_path", "by_reference", ' .
+            '"trim", "required", "read_only", "disabled", "max_length", "pattern", "property_path", "by_reference", ' .
             '"error_bubbling", "error_mapping", "label", "attr", "invalid_message", "invalid_message_parameters", ' .
             '"translation_domain", "empty_data"'
         );
@@ -507,7 +507,7 @@ public function testUnknownOption()
 
         $this->setExpectedException('Symfony\Component\Form\Exception\CreationException',
             'The option "unknown" does not exist. Known options are: "data", "data_class", ' .
-            '"trim", "required", "read_only", "max_length", "pattern", "property_path", "by_reference", ' .
+            '"trim", "required", "read_only", "disabled", "max_length", "pattern", "property_path", "by_reference", ' .
             '"error_bubbling", "error_mapping", "label", "attr", "invalid_message", "invalid_message_parameters", ' .
             '"translation_domain", "empty_data"'
         );