[Form] Fix #10658 Deprecate "read_only" option #10676

snoob · 2014-04-09T22:09:18Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#10658
License	MIT
Doc PR	symfony/symfony-docs#3782

romainneutron · 2014-04-09T22:18:53Z

You have to add a note about the deprecation in the changelog

snoob · 2014-04-09T23:08:55Z

@webmozart : Do you want to keep the template variable?

stloyd · 2014-04-10T07:37:50Z

src/Symfony/Component/Form/Extension/Core/Type/FormType.php

@@ -72,7 +72,8 @@ public function buildView(FormView $view, FormInterface $form, array $options)
        parent::buildView($view, $form, $options);

        $name = $form->getName();
-        $readOnly = $options['read_only'];
+
+        $readOnly =  isset($view->vars['attr']['readonly']) && in_array($view->vars['attr']['readonly'], array('readonly', true));


Shouldn't you just call the isset()? Cause here you do the strange in_array(), but later when fixing BC you just call: false !== $options['read_only']...

If we just call the isset() method we will be able to pass any value in the readonly attr (except for false) that's why i secured the test with an in_array() method.

You need to reverse the logic. According to html spec a boolean property is active when it is set (whatever the value). So readonly="0" is also readonly.
So I'd suggest $readOnly = isset($view->vars['attr']['readonly']) && false !== $view->vars['attr']['readonly']

Tobion · 2014-04-12T14:54:15Z

src/Symfony/Component/Form/Extension/Core/Type/FormType.php

@@ -191,7 +196,7 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
            'empty_data'         => $emptyData,
            'trim'               => true,
            'required'           => true,
-            'read_only'          => false,
+            'read_only'          => false, //Deprecated use attr['read_only'] instead


rpg600 · 2014-07-11T13:16:15Z

You can close this PR and merge #11376 instead.

Tobion · 2014-07-11T13:43:51Z

src/Symfony/Component/Form/Extension/Core/Type/FormType.php

@@ -183,6 +184,10 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
                $attributes['pattern'] = $options['pattern'];
            }

+            if (false !== $options['read_only']) {


I don't see why this is necessary?

snoob · 2014-07-16T12:08:36Z

I have done the missing changes on this PR it's not necessary to merge the #11376.

Tobion · 2014-07-16T12:38:49Z

src/Symfony/Component/Form/Extension/Core/Type/FormType.php

@@ -80,13 +81,12 @@ public function buildView(FormView $view, FormInterface $form, array $options)
            }

            // Complex fields are read-only if they themselves or their parents are.
-            if (!$readOnly) {
-                $readOnly = $view->parent->vars['read_only'];
+            if (!$readOnly && (isset($view->parent->vars['attr']['readonly']) && in_array($view->parent->vars['attr']['readonly'], array('readonly', true)))) {


same as above

snoob · 2014-07-19T23:02:10Z

@Tobion : I agree with you (about html spec). I've done the changes

Tobion · 2014-07-20T01:19:29Z

src/Symfony/Component/Form/Tests/Extension/Core/Type/FormTypeTest.php

@@ -127,7 +127,7 @@ public function testNonReadOnlyFormWithNonReadOnlyParentIsNotReadOnly()
                ->getForm()
                ->createView();

-        $this->assertFalse($view['child']->vars['read_only']);
+        $this->assertEquals(false, $view['child']->vars['attr']['readonly']);


assertFalse

webmozart · 2014-09-25T18:44:42Z

src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/widget_attributes.html.php

@@ -1,5 +1,4 @@
-id="<?php echo $view->escape($id) ?>" name="<?php echo $view->escape($full_name) ?>" <?php if ($read_only): ?>readonly="readonly" <?php endif ?>
-<?php if ($disabled): ?>disabled="disabled" <?php endif ?>
+id="<?php echo $view->escape($id) ?>" name="<?php echo $view->escape($full_name) ?>" <?php if ($disabled): ?>disabled="disabled" <?php endif ?>


Could you move the disabled clause to the next line, as it were?

Maybe the spaces should be before the html attributes in the php file too as it has been done on the twig form layout?

Tobion · 2014-10-07T21:18:06Z

As this is almost done, can we finish it?
Just needs one line change, rebase and changelog entry.

snoob · 2014-10-14T08:59:30Z

@Tobion : Which line have i missed?

Tobion · 2014-10-14T09:24:13Z

https://github.com/symfony/symfony/pull/10676/files#r18051243

snoob · 2014-10-14T09:32:55Z

I have already added this line https://github.com/snoob/symfony/commit/b5924e98aa04dca2f8e3acef031afee3565e9e12#diff-1

Tobion · 2014-10-14T10:04:49Z

You don't understand: It should be $view->vars['attr']['readonly'] = true;

wouterj · 2014-11-02T19:18:19Z

ping @snoob

snoob · 2014-11-03T10:14:35Z

@Tobion Sorry i had no time i ll try to fix today but i want to be sure about the rendering wanted.
Before :
<input type="text" readonly="readonly">
After
<input type="text" readonly> (like disabled)
Is that ok for you? May i change the Symfony version too i wrote deprecated since 2.6 but i think it will be 2.7 now as the PR took time?

@webmozart : I have notice that the spaces in the form_widget.php are before attributes whereas they are after in twig (the second one makes for sense)

Tobion · 2014-11-03T10:18:57Z

The rendering should stay the same with <input type="text" readonly="readonly"> even when readonly = true as this is how the template renders boolean values.

snoob · 2014-11-03T10:20:30Z

Ok thank you

Tobion · 2014-11-03T10:21:01Z

And disabled is also disabled="disabled". Why do you say it's not?

snoob · 2014-11-03T10:25:26Z

I thought it was i missed the boolean part conversion my bad

Tobion · 2014-11-03T10:40:39Z

Hm I think this PR still breaks for people who used 'read_only' => true option and at the same time passed some custom attributes. This will currently result in a field that is not read only.

snoob · 2014-11-06T09:12:49Z

@webmozart : Can i rebase now?

May i change the version too ? (deprecated since symfony 2.7 ?)

Tobion · 2014-11-22T01:21:09Z

src/Symfony/Component/Form/Extension/Core/Type/FormType.php

@@ -80,13 +79,13 @@ public function buildView(FormView $view, FormInterface $form, array $options)
            }

            // Complex fields are read-only if they themselves or their parents are.
-            if (!$readOnly) {
-                $readOnly = $view->parent->vars['read_only'];
+            if (!$view->vars['attr']['readonly'] && (isset($view->parent->vars['attr']['readonly']) && false !== $view->parent->vars['attr']['readonly'])) {


I don't think view->vars['attr']['readonly'] is ensured to be set.

Tobion · 2015-04-18T07:27:57Z

Another problem apart from #10676 (comment) is that people who used a custom theme will probably have readonly be rendered twice since it is now also added to the attr.

So I think the only thing we can do is to just deprecate the option by triggering an deprecation via a option normalizer as done for other options.

Tobion · 2015-04-19T00:54:05Z

Closed in favor of #14403

This PR was squashed before being merged into the 2.8 branch (closes #14403). Discussion ---------- [Form] deprecate read_only option | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #10658 | License | MIT | Doc PR | symfony/symfony-docs#3782 Replaces #10676 with a slightly different implementation. - fixes BC break when 'read_only' => true option and at the same time custom attributes are used by using a normalizer - adds deprecation notice - keeps legacy tests Commits ------- 53330e1 [Form] deprecate read_only option

[Form] Deprecated option "read_only"

9934c88

stloyd reviewed Apr 10, 2014
View reviewed changes

stof added the Form label Apr 10, 2014

Tobion reviewed Apr 12, 2014
View reviewed changes

Fixed spelling mistake

48ea257

xabbuh mentioned this pull request May 1, 2014

[Form] Deprecated read_only option symfony/symfony-docs#3824

Closed

jjsaunier mentioned this pull request May 1, 2014

[Form] Deprecated read_only option #10830

Closed

1 task

Tobion reviewed Jul 11, 2014
View reviewed changes

Removed an useless if

07c26cf

snoob mentioned this pull request Jul 16, 2014

[Form] Fix #10658 Deprecate "read_only" option #11376

Closed

Tobion reviewed Jul 16, 2014
View reviewed changes

Changed the readonly test according to Tobion suggestion

6fcb1ec

Tobion reviewed Jul 20, 2014
View reviewed changes

wouterj mentioned this pull request Jul 28, 2014

[Form] Deprecate "read_only" option #10658

Closed

Revert the read_only view variable + test refactoring

00ad6ea

webmozart reviewed Sep 25, 2014
View reviewed changes

snoob added 2 commits September 29, 2014 17:26

Fixed typo

45c5e3f

Applied webmozart advice

b5924e9

Applied webmozart feedback

c7abd9d

Tobion reviewed Nov 22, 2014
View reviewed changes

Tobion mentioned this pull request Apr 19, 2015

[Form] deprecate read_only option #14403

Closed

Tobion closed this Apr 19, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Form] Fix #10658 Deprecate "read_only" option #10676

[Form] Fix #10658 Deprecate "read_only" option #10676

snoob commented Apr 9, 2014

romainneutron commented Apr 9, 2014

snoob commented Apr 9, 2014

stloyd Apr 10, 2014

snoob Apr 11, 2014

Tobion Jul 16, 2014

Tobion Apr 12, 2014

rpg600 commented Jul 11, 2014

Tobion Jul 11, 2014

snoob commented Jul 16, 2014

Tobion Jul 16, 2014

snoob commented Jul 19, 2014

Tobion Jul 20, 2014

webmozart Sep 25, 2014

snoob Oct 14, 2014

Tobion commented Oct 7, 2014

snoob commented Oct 14, 2014

Tobion commented Oct 14, 2014

snoob commented Oct 14, 2014

Tobion commented Oct 14, 2014

wouterj commented Nov 2, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 6, 2014

Tobion Nov 22, 2014

Tobion commented Apr 18, 2015

Tobion commented Apr 19, 2015

[Form] Fix #10658 Deprecate "read_only" option #10676

[Form] Fix #10658 Deprecate "read_only" option #10676

Conversation

snoob commented Apr 9, 2014

romainneutron commented Apr 9, 2014

snoob commented Apr 9, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rpg600 commented Jul 11, 2014

Choose a reason for hiding this comment

snoob commented Jul 16, 2014

Choose a reason for hiding this comment

snoob commented Jul 19, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tobion commented Oct 7, 2014

snoob commented Oct 14, 2014

Tobion commented Oct 14, 2014

snoob commented Oct 14, 2014

Tobion commented Oct 14, 2014

wouterj commented Nov 2, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 3, 2014

Tobion commented Nov 3, 2014

snoob commented Nov 6, 2014

Choose a reason for hiding this comment

Tobion commented Apr 18, 2015

Tobion commented Apr 19, 2015