Add PHP7 compatible versions for the Null/True/False constraints as they are reserved words in PHP7 #14228

stefanruijsenaars · 2015-04-05T23:36:10Z

Q	A
Bug fix?	PHP7 compatibility
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	N/A
Fixed tickets	N/A - helps towards #14086
License	MIT

Null, True and False are reserved words in PHP7:

https://wiki.php.net/rfc/reserve_more_types_in_php_7

stefanruijsenaars · 2015-04-05T23:50:58Z

We can actually provide the deprecated classes through a class_alias...

Tobion · 2015-04-06T01:43:50Z

You missed to rename the file NullValidatorTest.php

nicolas-grekas · 2015-04-06T08:16:47Z

src/Symfony/Component/Validator/Constraints/Null.php

-{
-    public $message = 'This value should be null.';
-}
+class_alias('NullConstraint', 'Null');


The full namespace must be provided

In order to keep type hints working (... instanceof Null), this class_alias should be moved at the end of NullConstraint.php, and this very line should be replaced by a class_exists('Symfony\Component\Validator\Constraints\NullConstraints');

nicolas-grekas · 2015-04-06T08:19:30Z

You should do the False and True constraints in the same PR I believe

nicolas-grekas · 2015-04-06T08:20:13Z

src/Symfony/Component/Validator/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========

+New version


nicolas-grekas · 2015-04-06T09:29:57Z

Do we really want to do that on 2.3? Deprecations are usually forbidden on 2.3.
I'd personally be fine with having PHP7 being fully supported with 2.7 only.

GromNaN · 2015-04-06T09:33:21Z

About the new class name. What about IsNull instead ? That way we can write Assert\IsNull.

Tobion · 2015-04-06T09:55:07Z

We don't deprecate things in maintenance branches. This must be done in 2.7

fabpot · 2015-04-06T11:44:22Z

The only reason to add those deprecation in 2.3 would be to allow 2.3 to be PHP 7 compatible. Is that what we want?

wouterj · 2015-04-06T11:58:14Z

What about Nil and NotNil?

stefanruijsenaars · 2015-04-06T12:02:12Z

If 2.3 is still supported by the time PHP 7 comes out it would make sense to put this in 2.3, per #14086 we're quite close to being compatible so if we drop PHP 7 support it shouldn't be just because we're deprecating a few constraints :)

Does anyone have any further ideas about new names for the following constraints, I've already seen the following:
NotNull: NotNull (*as it's not a reserved word) / NotNil / IsNotNull / NotNullConstraint
Null: Nil / IsNull / NullConstraint
True: Truthy / IsTrue / TrueConstraint
False: Falsy / IsFalse / FalseConstraint

sstok · 2015-04-06T12:13:05Z

I would vote for isNull as its descriptive and consistent with isTrue.

stefanruijsenaars · 2015-04-06T13:15:39Z

I will add the new True and False constraints to this PR as well once the Null constraint has been properly reviewed and once there's consensus on the new naming.

Just FYI, this is currently causing a test failure on Drupal 8/PHP 7 as it uses the Null constraint in a test.

dosten · 2015-04-06T13:53:17Z

@wouterj 👍 Also Truthy and Falsy. What do you think?

stefanruijsenaars · 2015-04-08T10:30:20Z

Thanks all, just to be clear, what are we renaming these constraints to?

stof · 2015-04-08T11:59:42Z

src/Symfony/Component/Validator/Constraints/NullConstraint.php

+    public $message = 'This value should be null.';
+}
+
+class_alias('Symfony\Component\Validator\Constraints\NullConstraint', 'Symfony\Component\Validator\Constraints\Null');


this line should be skipped on PHP7, otherwise the issue is not solved

stof · 2015-04-08T12:00:36Z

The NullValidator needs to be deprecated too

stefanruijsenaars · 2015-04-19T22:11:14Z

Does this seem ready? What still needs to happen here?

xabbuh · 2015-04-21T19:38:27Z

src/Symfony/Component/Validator/Constraints/IsNull.php

+    public $message = 'This value should be null.';
+}
+
+if (version_compare(PHP_VERSION, '7.0.0-dev') < 0) {


Can't we use PHP_VERSION_ID < 70000 instead?

We should. For consistency.

stof · 2015-04-21T20:07:56Z

@stefanruijsenaars the comment from @nicolas-grekas in #14228 (comment) has not been taken into account

stof · 2015-04-21T20:08:59Z

@stefanruijsenaars note that your commits are not associated to your github account (the email used when committing is not known by github). You might want to change this

nicolas-grekas · 2015-04-22T08:23:20Z

src/Symfony/Component/Validator/Constraints/Null.php

-{
-    public $message = 'This value should be null.';
-}
+class_exists('Symfony\Component\Validator\Constraints\IsNull');


I agree with @stof above: this should be replaced by class_alias

I agree as well. @stefanruijsenaars could you do this change?

Tobion · 2015-04-22T19:55:05Z

The trigger_error calls must be added. Oh this is for 2.3. Then these calls should be added in 2.7 i guess.

Tobion · 2015-04-22T20:00:07Z

And the same approach should be done for False and True.

stefanruijsenaars · 2015-04-23T07:45:53Z

As soon as I have confirmation that this looks good as far as Null is concerned I can do the same for False and True...

nicolas-grekas · 2015-04-23T07:58:41Z

Is it possible that someone has type hinted Constraints\Null or Constraints\NullValidator (same question for False/True?)
Because the new classes do not pass the deprecated hints, which is a BC break.
To make it pass, we must make IsNullValidator extend the deprecated NullValidator.
We must also alias Null when loading IsNull, and load IsNull from Null.php using class_exists (I know, I said the opposite yesterday, sorry for the mistake...)

nicolas-grekas · 2015-05-10T11:37:14Z

src/Symfony/Component/Form/Tests/Extension/Validator/ValidatorTypeGuesserTest.php

+    }
+
+    /**
+     * @dataProvider legacyGuessRequiredProvider


We don't need the data provider

stefanruijsenaars · 2015-05-11T09:15:02Z

The checks seems stuck, can we re-queue this somehow?

nicolas-grekas · 2015-05-11T09:19:41Z

src/Symfony/Component/Form/Tests/Extension/Validator/ValidatorTypeGuesserTest.php

+     */
+    public function testLegacyGuessRequired()
+    {
+      if (PHP_VERSION_ID >= 70000) {


two indentation spaces missing for the whole method

Berdir · 2015-05-11T22:08:18Z

I wasn't able to reproduce the recursion that travis reports. The validator tests are running through for me on php7 (PHP 7.0.0-dev (cli) (built: May 6 2015 00:41:14)).

However, I have a lot of test fails, all because the string representation of a DateTime object is somehow different, it expects 'Jan 1, 2000, 12:00 AM' but actually gets 'Jan 1, 2000 12:00 AM' (note the missing , after the year). But that seems like a different problem and could be environment specific.

nicolas-grekas · 2015-05-12T14:24:48Z

ping @symfony/deciders

Tobion · 2015-05-12T17:02:25Z

src/Symfony/Component/Validator/Constraints/NullValidator.php

 /**
 * @author Bernhard Schussek <[email protected]>
 *
 * @api
+ *
+ * @deprecated Deprecated since version 2.3.28, to be removed in 3.0. Use


We do not add deprecations in patch versions. So this comment should should only be added in 2.7.

together with trigger_errors

So trigger_errors in 2.7 only?

This discussion had appeared earlier in this thread as well, I think back then it was decided to make an exception? Though @fabpot did mention the deprecations would only be necessary if we wanted to make the branch PHP7 compatible.

I just talked with @fabpot in person and yes the deprecation and trigger_error is only in 2.7.

2.3 will be PHP 7 compatible for Symfony for out-of-the-box, but we won't prevent others from still using the old constraints, etc. (and such make it PHP 7 incompatible)

That way 2.3 is compatible out-of-the-box for Drupal + PHP 7, but you could still shoot yourself in the foot with a custom extension.

In 2.7 then it will start with deprecation notices.

LionsAd · 2015-05-13T00:47:38Z

So we probably need a 2.7 PR as well?

nicolas-grekas · 2015-05-13T08:32:32Z

@stefanruijsenaars can you please remove any comment telling about deprecation (in the patch but also in the PR title/description)?
We are going to consider this as a pure bug fix on 2.3, and we will make an other PR on 2.7 to add the deprecation back after the merge.

stefanruijsenaars · 2015-05-13T08:44:43Z

Done

nicolas-grekas · 2015-05-13T08:52:41Z

src/Symfony/Component/Validator/CHANGELOG.md

+------
+
+ * added PHP7-compatible versions for the constraints Null, True and False (IsNull, IsTrue, IsFalse)
+ * added PHP7-compatible versions for the constraint validators NullValidator, TrueValidator and FalseValidator (IsNullValidator, IsTrueValidator, IsFalseValidator)


I propose a single line:

fixed compatibility with PHP7 and up by introducing new constraints (IsNull, IsTrue, IsFalse) and related validators (IsNullValidator, IsTrueValidator, IsFalseValidator)

nicolas-grekas · 2015-05-13T08:58:21Z

Looking at the tests, you need to patch one more file:
https://github.com/stefanruijsenaars/symfony/blob/php7-nullconstraint/src/Symfony/Component/Form/composer.json#L28
should be:
"symfony/validator": "~2.3.0,>=2.3.29",

xabbuh · 2015-05-13T09:08:52Z

Why not using ~2.3.29 instead then?

nicolas-grekas · 2015-05-13T09:09:40Z

@xabbuh indeed

Tobion · 2015-05-13T09:26:06Z

👍

…IsNull, IsTrue, IsFalse) and related validators (IsNullValidator, IsTrueValidator, IsFalseValidator)

stof · 2015-05-15T09:23:22Z

👍

stof · 2015-05-15T09:25:47Z

Thanks for your work on this @stefanruijsenaars.

…straints as they are reserved words in PHP7 (stefan.r) This PR was merged into the 2.3 branch. Discussion ---------- Add PHP7 compatible versions for the Null/True/False constraints as they are reserved words in PHP7 | Q | A | ------------- | --- | Bug fix? | PHP7 compatibility | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | N/A | Fixed tickets | N/A - helps towards #14086 | License | MIT Null, True and False are reserved words in PHP7: https://wiki.php.net/rfc/reserve_more_types_in_php_7 Commits ------- 44edbdf Fixed compatibility with PHP7 and up by introducing new constraints (IsNull, IsTrue, IsFalse) and related validators (IsNullValidator, IsTrueValidator, IsFalseValidator)

stefanruijsenaars · 2015-05-29T11:57:19Z

Do we have a 2.7 PR for this yet?

2015-05-15 11:26 GMT+02:00 Christophe Coevoet [email protected]:

Merged #14228 #14228.

—
Reply to this email directly or view it on GitHub
#14228 (comment).

nicolas-grekas · 2015-05-29T17:05:44Z

@stefanruijsenaars it is already in 2.7, check the git log

More info: symfony/symfony#14228

nicolas-grekas reviewed Apr 6, 2015
View reviewed changes

src/Symfony/Component/Validator/CHANGELOG.md

@@ -1,6 +1,11 @@

CHANGELOG

=========

New version

Copy link

Member

nicolas-grekas Apr 6, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.3.28

stof reviewed Apr 8, 2015
View reviewed changes

stof mentioned this pull request Apr 13, 2015

[Valdiator] PHP Fatal error: Cannot use 'True' as class name as it is reserved #14336

Closed

xabbuh added the Validator label Apr 21, 2015

xabbuh reviewed Apr 21, 2015
View reviewed changes

nicolas-grekas reviewed Apr 22, 2015
View reviewed changes

nicolas-grekas reviewed May 10, 2015
View reviewed changes

nicolas-grekas reviewed May 11, 2015
View reviewed changes

Tobion reviewed May 12, 2015
View reviewed changes

stefanruijsenaars changed the title ~~Deprecate Null/True/False constraints as they are reserved words in PHP7~~ Add PHP7 compatible versions for the Null/True/False constraints as they are reserved words in PHP7 May 13, 2015

nicolas-grekas reviewed May 13, 2015
View reviewed changes

Fixed compatibility with PHP7 and up by introducing new constraints (…

44edbdf

…IsNull, IsTrue, IsFalse) and related validators (IsNullValidator, IsTrueValidator, IsFalseValidator)

stof merged commit 44edbdf into symfony:2.3 May 15, 2015

xabbuh mentioned this pull request Sep 5, 2015

Deprecated class replacement symfony/symfony-docs#5665

Closed

conradkleinespel mentioned this pull request Jan 21, 2016

IsNull but NotNull instead of IsNotNull #17477

Closed

xezpeleta added a commit to elkarbackup/elkarbackup that referenced this pull request Sep 27, 2016

PHP7 compatibility, do not use reserved words (fixes #161)

f264e65

More info: symfony/symfony#14228

konandrum added a commit to IDCI-Consulting/ExtraFormBundle that referenced this pull request Jan 25, 2017

Fix php7 compatibility (see symfony/symfony#14228)

b40ed52

Add PHP7 compatible versions for the Null/True/False constraints as they are reserved words in PHP7 #14228

Add PHP7 compatible versions for the Null/True/False constraints as they are reserved words in PHP7 #14228

Conversation

stefanruijsenaars commented Apr 5, 2015

stefanruijsenaars commented Apr 5, 2015

Tobion commented Apr 6, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Apr 6, 2015

Choose a reason for hiding this comment

nicolas-grekas commented Apr 6, 2015

GromNaN commented Apr 6, 2015

Tobion commented Apr 6, 2015

fabpot commented Apr 6, 2015

wouterj commented Apr 6, 2015

stefanruijsenaars commented Apr 6, 2015

sstok commented Apr 6, 2015

stefanruijsenaars commented Apr 6, 2015

dosten commented Apr 6, 2015

stefanruijsenaars commented Apr 8, 2015

Choose a reason for hiding this comment

stof commented Apr 8, 2015

stefanruijsenaars commented Apr 19, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Apr 21, 2015

stof commented Apr 21, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tobion commented Apr 22, 2015

Tobion commented Apr 22, 2015

stefanruijsenaars commented Apr 23, 2015

nicolas-grekas commented Apr 23, 2015

Choose a reason for hiding this comment

stefanruijsenaars commented May 11, 2015

Choose a reason for hiding this comment

Berdir commented May 11, 2015

nicolas-grekas commented May 12, 2015

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

LionsAd commented May 13, 2015

nicolas-grekas commented May 13, 2015

stefanruijsenaars commented May 13, 2015

Choose a reason for hiding this comment

nicolas-grekas commented May 13, 2015

xabbuh commented May 13, 2015

nicolas-grekas commented May 13, 2015

Tobion commented May 13, 2015

stof commented May 15, 2015

stof commented May 15, 2015

stefanruijsenaars commented May 29, 2015

nicolas-grekas commented May 29, 2015