fix #17993 - Deprecated callable strings #18020

Simperfit · 2016-03-05T09:41:57Z

Q	A
Branch	master
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	yes
Tests pass?	no
Fixed tickets	#17993
License	MIT
Doc PR

Is this ok ?

Rebase when [Form] handle callable strings in PropertyAccessDecorator #18057 is merged

Simperfit · 2016-03-05T10:29:54Z

Thank you, I didn't understand the issue correctly.

I've changed my fix.

Tobion · 2016-03-05T11:42:35Z

src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php

@@ -163,6 +175,8 @@ public function createView(ChoiceListInterface $list, $preferredChoices = null,

        if (is_string($preferredChoices) && !is_callable($preferredChoices)) {
            $preferredChoices = new PropertyPath($preferredChoices);
+        } elseif(is_string($preferredChoices) && is_callable($preferredChoices)) {


missing space after elseif

HeahDude · 2016-03-05T14:53:50Z

Not on these methods for sure.

HeahDude · 2016-03-05T14:54:50Z

src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php

@@ -86,6 +86,8 @@ public function createListFromChoices($choices, $value = null)
    {
        if (is_string($value) && !is_callable($value)) {
            $value = new PropertyPath($value);
+        } elseif (is_string($value) && is_callable($value)) {
+            @trigger_error('createListFromChoices() treats callable strings as callable and is deprecated since version 3.0.', E_USER_DEPRECATED);


since version 3.1 (for now)

HeahDude · 2016-03-05T16:00:06Z

You could perhaps wrap the callable string in a closure inside those elseif to prevent the fatal error.

elseif (is_string($label) && is_callable($label)) {
    @trigger_error('createView() - $label - treats callable strings as callable and is deprecated since version 3.0.', E_USER_DEPRECATED);

    $label = function ($choice) use ($label) {
        return $label($choice);
    };
}

Simperfit · 2016-03-05T17:47:43Z

I have no errors doing the tests except of one in PasswordEncoder.

Thanks @HeahDude for the help

linaori · 2016-03-05T22:05:14Z

src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php

@@ -86,6 +86,11 @@ public function createListFromChoices($choices, $value = null)
    {
        if (is_string($value) && !is_callable($value)) {
            $value = new PropertyPath($value);
+        } elseif (is_string($value) && is_callable($value)) {
+            @trigger_error('createListFromChoices() treats callable strings as callable and is deprecated since version 3.1.', E_USER_DEPRECATED);


If it's deprecated, what's the recommended thing to do instead? What will happen in 4.0? Please add this to the deprecation messages (and upgrade guide)

@iltar is right. You should change each message to something like :

'Treating strings as callable is deprecated since version 3.1 and will throw an error in 4.0. You should use a "\Closure" instead.'

HeahDude · 2016-03-05T22:44:14Z

I have no errors doing the tests except of one in PasswordEncoder.

What error are you talking about ?

Simperfit · 2016-03-05T23:14:55Z

Nevermind, no error anymore

fabpot · 2016-03-06T10:36:11Z

@Simperfit What about adding some unit tests?

Simperfit · 2016-03-06T22:54:05Z

@fabpot I added one, will add one for each method

xabbuh · 2016-03-07T11:34:17Z

Looks like this needs another rebase. It contains some unrelated changes.

Status: Needs work

Simperfit · 2016-03-07T18:19:42Z

@xabbuh Sorry for the unrelated changes, I've missed my rebase.

xabbuh · 2016-03-07T18:38:28Z

src/Symfony/Component/Form/ChoiceList/Factory/PropertyAccessDecorator.php

+                return $value($choices);
+            };
+
+            return $value($choices);


Do we need to do all the stuff beside triggering the deprecation? Shouldn't the following code already handle the callback properly?

I've followed the instruction of someone since I don't wanted to make bad things,
But you're right, adding the test without any code is the right thing to do.

Thanks

Simperfit · 2016-03-07T19:21:03Z

@fabpot I've added one test for each method, is it ok like that ? Thank you.

HeahDude · 2016-04-01T18:51:40Z

UPGRADE-4.0.md

+ * Using callable strings as choice options in ChoiceType has been deprecated
+  in favor of `PropertyPath`. Use a "\Closure" instead
+
+    Before:


Ok now you got one extra here

Simperfit · 2016-04-01T18:56:26Z

I've rebased and added/removed the space :p

HeahDude · 2016-04-01T19:16:46Z

UPGRADE-4.0.md

+    ```php
+    'choice_value' => 'range',
+    'choice_label' => function ($choice) {
+    return strtoupper($choice);


You misunderstood the "four" space here mean four for this line only.

Now on got one extra space from line 23 to 37 and missing 3 here one 35 :p

Sorry, after that we're done, thank you for working on this PR :)

I hope this time it's ok :p

Np :)

HeahDude · 2016-04-01T19:28:51Z

UPGRADE-4.0.md

@@ -55,6 +75,8 @@ FrameworkBundle
    - `"form.type.submit"`
    - `"form.type.reset"`

+   `ArrayAccess` in `ResizeFormListener::preSubmit` method has been removed


~~to not conflict with master it must be before your change~~

ok just remove it

HeahDude · 2016-04-02T09:28:56Z

Looks perfect now :) Thanks @Simperfit!

This one is ready to merge now.

Deprecate or revert 470b140 ? ping @symfony/decoders

Simperfit · 2016-04-02T09:34:45Z

ping @Tobion @fabpot @dunglas

xabbuh · 2016-04-05T11:47:26Z

UPGRADE-4.0.md

@@ -16,6 +16,26 @@ Form

 * Support for data objects that implements both `Traversable` and
   `ArrayAccess` in `ResizeFormListener::preSubmit` method has been removed.
+
+ * Using callable strings as choice options in ChoiceType has been deprecated
+   in favor of `PropertyPath`. Use a "\Closure" instead


The sentence as is must be added to the UPGRADE-3.1.md file. In this file it should read like "Using callable strings as choice options in ChoiceType has been removed in favor of passing PropertyPath instances."

is it ok like this @HeahDude @xabbuh ?

HeahDude · 2016-04-05T17:46:38Z

UPGRADE-4.0.md

@@ -16,6 +16,25 @@ Form

 * Support for data objects that implements both `Traversable` and
   `ArrayAccess` in `ResizeFormListener::preSubmit` method has been removed.
+
+ * Using callable strings as choice options in ChoiceType has been removed in favor of passing PropertyPath instances.
+


I would replace "has been removed" by "is not supported anymore".

But please wait for a symfony decider to tell you if it's ok. Thanks :)

You are right. That sounds a bit better.

fabpot · 2016-04-06T12:07:30Z

src/Symfony/Component/Form/CHANGELOG.md

@@ -7,6 +7,9 @@ CHANGELOG
 * deprecated the "choices_as_values" option of ChoiceType
 * deprecated support for data objects that implements both `Traversable` and
   `ArrayAccess` in `ResizeFormListener::preSubmit` method
+
+ * Using callable strings as choice options in `ChoiceType` has been deprecated
+  and will be used as `PropertyPath` instead of callable in Symfony 4.0.


missing space at the beginning of the line

@fabpot space added.

ext

Simperfit · 2016-04-15T05:56:52Z

i've rebased with master.
ping @fabpot @webmozart @Tobion

fabpot · 2016-04-15T08:52:51Z

IIRC, we were waiting for @Tobion's opinion about merging or reverting instead.

Tobion · 2016-04-15T09:13:02Z

I would revert but I'm ok with both ways.

fabpot · 2016-04-15T10:09:11Z

Thank you @Simperfit.

This PR was merged into the 3.1-dev branch. Discussion ---------- fix #17993 - Deprecated callable strings | Q | A | ------------- | --- | Branch | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | no | Fixed tickets | #17993 | License | MIT | Doc PR | Is this ok ? - [x] Rebase when #18057 is merged Commits ------- 191b495 fix #17993 - Deprecated callable strings

Simperfit · 2016-04-17T15:11:23Z

NP @fabpot.

carsonbot added the Status: Needs Review label Mar 5, 2016

javiereguiluz added the Form label Mar 5, 2016

Tobion reviewed Mar 5, 2016
View reviewed changes

HeahDude reviewed Mar 5, 2016
View reviewed changes

linaori reviewed Mar 5, 2016
View reviewed changes

Simperfit force-pushed the master branch from 9255f75 to 39e9859 Compare March 6, 2016 14:51

javiereguiluz added the Deprecation label Mar 6, 2016

Simperfit force-pushed the master branch from 35c2c52 to b070941 Compare March 6, 2016 22:48

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 7, 2016

Simperfit force-pushed the master branch from b070941 to 4ae9bf6 Compare March 7, 2016 18:18

xabbuh reviewed Mar 7, 2016
View reviewed changes

Simperfit force-pushed the master branch 4 times, most recently from cd2bf8e to 22f8264 Compare March 7, 2016 19:20

Simperfit force-pushed the master branch from edec798 to c6625c9 Compare April 1, 2016 18:48

HeahDude reviewed Apr 1, 2016
View reviewed changes

Simperfit force-pushed the master branch from c6625c9 to 4747e35 Compare April 1, 2016 18:55

Simperfit force-pushed the master branch 2 times, most recently from c3b996d to 12975bd Compare April 1, 2016 19:04

HeahDude reviewed Apr 1, 2016
View reviewed changes

Simperfit force-pushed the master branch from 12975bd to 4f2108f Compare April 1, 2016 19:22

HeahDude reviewed Apr 1, 2016
View reviewed changes

Simperfit force-pushed the master branch from 4f2108f to a56a32b Compare April 2, 2016 08:15

xabbuh reviewed Apr 5, 2016
View reviewed changes

Simperfit force-pushed the master branch from a56a32b to d2f6434 Compare April 5, 2016 17:33

HeahDude reviewed Apr 5, 2016
View reviewed changes

Simperfit force-pushed the master branch from d2f6434 to b8aa179 Compare April 5, 2016 18:03

fabpot reviewed Apr 6, 2016
View reviewed changes

Simperfit force-pushed the master branch from b8aa179 to 560d229 Compare April 6, 2016 21:10

fix symfony#17993 - Deprecated callable strings

191b495

ext

Simperfit force-pushed the master branch from 560d229 to 191b495 Compare April 15, 2016 05:56

fabpot merged commit 191b495 into symfony:master Apr 15, 2016

fabpot mentioned this pull request May 13, 2016

Release v3.1.0-BETA1 #18776

Merged

xabbuh mentioned this pull request Jan 25, 2018

check empty_data in choices of ChoiceType #25899

Closed

fix #17993 - Deprecated callable strings #18020

fix #17993 - Deprecated callable strings #18020

Conversation

Simperfit commented Mar 5, 2016

Simperfit commented Mar 5, 2016

Choose a reason for hiding this comment

HeahDude commented Mar 5, 2016

Choose a reason for hiding this comment

HeahDude commented Mar 5, 2016

Simperfit commented Mar 5, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HeahDude commented Mar 5, 2016

Simperfit commented Mar 5, 2016

fabpot commented Mar 6, 2016

Simperfit commented Mar 6, 2016

xabbuh commented Mar 7, 2016

Simperfit commented Mar 7, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Mar 7, 2016

Choose a reason for hiding this comment

Simperfit commented Apr 1, 2016

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

HeahDude commented Apr 2, 2016

Simperfit commented Apr 2, 2016

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

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

Simperfit commented Apr 15, 2016

fabpot commented Apr 15, 2016

Tobion commented Apr 15, 2016

fabpot commented Apr 15, 2016

Simperfit commented Apr 17, 2016