[3.0] #29 - PHP7 compliance #30

Ocramius · 2016-01-03T23:32:19Z

This is a first draft that requires a look by @weierophinney.

Features

This patch introduces a few features that are very much required in order to use Zend\Code in PHP7 (currently generates broken garbage, which is what forced me to write the patch in first place).

by-ref method return support (ported from ProxyManager)
variadic support
scalar type hint support (this required a BC break, documented below)
return type hint support

BC Breaks

This patch introduces a couple of BC Breaks:

Zend\Code\Reflection\ParameterReflection#getType() required a rename, since it clashes with the newly introduced ReflectionParameter#getType()
Zend\Code\Generator\ParameterGenerator#setType() now expects users to pass in the type without prefixing it with \\
Zend\Code\Generator\ParameterGenerator#getType() now returns the types without the prefixing \\
Zend\Code\Generator\ParameterGenerator#generate() now generates types with a prefixing \\ when a class is given: all classes should be provided via fully qualified class name. Passing in a name prefixed with \\ is supported, but when asking for a type, a string without the prefixing \\ will be retrieved.
Zend\Code\Generator\ParameterGenerator now doesn't consider int, string, float, bool as special types, and doesn't omit them from generated signatures anymore. Note: while this is broken as heck, people may have relied on it, and the BC break is subtle, but required
Zend\Code\Generator\ParameterGenerator#$type is now a Zend\Code\Generator\TypeGenerator (stringable, but not a string)
protected static Zend\Code\Generator\ParameterGenerator::$simple was dropped

TODO

document BC breaks

Notes

Commits are not to be squashed, as I'm detailing progress in each commit, especially around edge cases.

Ocramius · 2016-01-03T23:33:23Z

src/Reflection/FunctionReflection.php

@@ -135,7 +135,7 @@ public function getPrototype($format = FunctionReflection::PROTOTYPE_AS_ARRAY)
        $parameters = $this->getParameters();
        foreach ($parameters as $parameter) {
            $prototype['arguments'][$parameter->getName()] = [
-                'type'     => $parameter->getType(),
+                'type'     => $parameter->detectType(),


I am not sure why we have a getPrototype API: seems useless

@Ocramius — It's used by Zend\Server\Reflection, and thus the Zend\XmlRpc\Server, Zend\Json\Server, and Zend\Soap\Server implementations in order to provide the various possible method invocation combinations so that they can:

provide API usage

validate provided parameters when processing a request

We moved it out of Zend\Server\Reflection, IIRC. We could potentially move it back in, but I'd also argue it's a value-add for this component.

@weierophinney doesn't need to be moved out of the component, just out of this class, IMO (future change)

Maybe start a TODO for those future changes. 😄

nilportugues · 2016-01-03T23:36:17Z

👏 this is great stuff. I'm so looking forward to this!

Ocramius · 2016-01-04T03:39:50Z

Note: I re-added support for PHP 5.x, although it's nasty and it will produce different results with string, float, etc...

samsonasik · 2016-01-04T20:22:34Z

src/Generator/MethodGenerator.php

+    }
+
+    /**
+     * @param boolean $returnsReference


@param bool for consistency

…names

…names - refactored tests

…ce` class names

…s with PHP7's `ReflectionParameter#getType()`

… a generator

…pe`, adding tests for `detectType`

Ocramius · 2016-01-05T07:21:40Z

@weierophinney this is all set and ready to go :-)

CHANGELOG.md and UPGRADE.md also provided.

gianarb · 2016-01-05T11:55:06Z

👍 Thanks for this effort!

weierophinney · 2016-01-07T20:25:52Z

UPGRADE.md

+In 3.x, this code will instead produce `"string $foo"`.
+If you generate code that should run in PHP 5.x, it is advisable to strip
+`string`, `int`, `float` and `bool` from type definitions passed to
+`Zend\Code\ParameterGenerator` instances.


Can you indicate how one would do this, please?

Will add an example

weierophinney · 2016-01-07T20:47:42Z

@Ocramius This looks great! I have a few requests for clarifications above, as well as some questions about docblock-based typehints.

…ing PHP5-compliant code

…MethodGenerator::fromReflection()` is required

…comment

Ocramius · 2016-01-13T09:51:10Z

@weierophinney applied changes according to your review, thanks!

weierophinney · 2016-01-13T14:57:38Z

Final comments:

Make the PHP requirement ^5.5 || ^7.0, for consistency with other components.
Update the branch alias for dev-develop to 3.0-dev.
Please create a "migration" guide in the documentation; you can crib a lot (most?) of it from your UPGRADE.md, but that way it can be part of a published manual as well.

Excellent work, Marco! With those minor changes, I'll merge, and prepare the 3.0 tag!

…y, as part of the doctree

…r for SEO)

weierophinney · 2016-01-13T16:37:30Z

@Ocramius Perfect; thanks!

[3.0] #29 - PHP7 compliance

Close #30

Ocramius · 2016-01-13T19:44:43Z

Ocramius added enhancement BC Break labels Jan 3, 2016

Ocramius assigned weierophinney Jan 3, 2016

Ocramius added this to the 3.0.0 milestone Jan 3, 2016

Ocramius changed the title ~~[3.0] PHP7 compliance~~ [3.0] #29 - PHP7 compliance Jan 3, 2016

Ocramius reviewed Jan 3, 2016
View reviewed changes

This was referenced Jan 4, 2016

[WIP] Support scalar type hinting for php7 Ocramius/ProxyManager#241

Closed

Feature - #241 - support scalar type hints Ocramius/ProxyManager#271

Merged

Ocramius added the awaiting maintainer response label Jan 4, 2016

samsonasik reviewed Jan 4, 2016
View reviewed changes

src/Generator/MethodGenerator.php

}

/**

* @param boolean $returnsReference

Copy link

Contributor

samsonasik Jan 4, 2016

Choose a reason for hiding this comment

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

@param bool for consistency

Ocramius added 15 commits January 5, 2016 07:11

PHP7 is not allowed to fail

7311e3a

Data-provider for simple type-hints

39a386b

zendframework#29 - Testing simple hints syntax

bcf6223

zendframework#29 - Explicitly setting php version boundaries

6faf241

zendframework#29 - Bumping PHPUnit version

4c9ae77

zendframework#29 - Adding scalar type-hints support

3a9ec67

zendframework#29 - mixed, object, resource are all valid class …

e9ec0b7

…names

zendframework#29 - mixed, object, resource are all valid class …

5c6ba37

…names - refactored tests

zendframework#29 - Enabling support for mixed, object and `resour…

f599b31

…ce` class names

zendframework#29 - Removing duplicate tests

1a87fc4

zendframework#29 - Renaming getType to detectType to avoid clashe…

7fba25a

…s with PHP7's `ReflectionParameter#getType()`

zendframework#29 - Test asset: class with internal type hints

bdcff2d

zendframework#29 - Internal type hints should be reflected when using…

551b033

… a generator

zendframework#29 - fromReflection should honor internal type hints

5452dc1

zendframework#29 - Verifying that getType retrieves a `ReflectionTy…

141a655

…pe`, adding tests for `detectType`

zendframework#29 - removing un-wanted scalar type hint from the API

ae152d0

weierophinney reviewed Jan 7, 2016
View reviewed changes

weierophinney added awaiting author updates and removed awaiting maintainer response labels Jan 7, 2016

Ocramius added 3 commits January 13, 2016 10:25

zendframework#29 - clarifying on how to filter out types when generat…

aefbf04

…ing PHP5-compliant code

zendframework#29 - clarifying why the change of `Zend\Code\Generator\…

d3667c5

…MethodGenerator::fromReflection()` is required

zendframework#29 - linking scalar type hints as per @weierophinney's …

b004d95

…comment

Ocramius removed the awaiting author updates label Jan 13, 2016

Ocramius added 5 commits January 13, 2016 16:33

zendframework#29 - s/~/^ (consistency with other components)

3f3bdfc

zendframework#29 - using || instead of | (deprecated)

2f06164

zendframework#29 - develop is 3.0-dev

9acd1e6

zendframework#29 - moving upgrade notes to the documentation director…

61edb5b

…y, as part of the doctree

zendframework#29 - more specific upgrade notes file name/title (bette…

b464169

…r for SEO)

weierophinney merged commit b464169 into zendframework:develop Jan 13, 2016

weierophinney added a commit that referenced this pull request Jan 13, 2016

Merge pull request #30 from Ocramius/feature/php7-compliance

9997372

[3.0] #29 - PHP7 compliance

weierophinney added a commit that referenced this pull request Jan 13, 2016

Merge branch 'feature/30' into develop

e088cc0

Close #30

weierophinney mentioned this pull request Jan 13, 2016

[RFC] PHP7 scalar type-hints and return type-hints support #29

Closed

Ocramius deleted the feature/php7-compliance branch January 13, 2016 19:44

captn3m0 mentioned this pull request Dec 23, 2016

PHP7 Typehinting support goetas-webservices/xsd2php#8

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.0] #29 - PHP7 compliance #30

[3.0] #29 - PHP7 compliance #30

Ocramius commented Jan 3, 2016

Ocramius Jan 3, 2016

weierophinney Jan 7, 2016

Ocramius Jan 8, 2016

weierophinney Jan 13, 2016

nilportugues commented Jan 3, 2016

Ocramius commented Jan 4, 2016

samsonasik Jan 4, 2016

Ocramius commented Jan 5, 2016

gianarb commented Jan 5, 2016

weierophinney Jan 7, 2016

Ocramius Jan 8, 2016

weierophinney commented Jan 7, 2016

Ocramius commented Jan 13, 2016

weierophinney commented Jan 13, 2016

weierophinney commented Jan 13, 2016

Ocramius commented Jan 13, 2016

[3.0] #29 - PHP7 compliance #30

[3.0] #29 - PHP7 compliance #30

Conversation

Ocramius commented Jan 3, 2016

Features

BC Breaks

TODO

Notes

Ocramius Jan 3, 2016

Choose a reason for hiding this comment

weierophinney Jan 7, 2016

Choose a reason for hiding this comment

Ocramius Jan 8, 2016

Choose a reason for hiding this comment

weierophinney Jan 13, 2016

Choose a reason for hiding this comment

nilportugues commented Jan 3, 2016

Ocramius commented Jan 4, 2016

samsonasik Jan 4, 2016

Choose a reason for hiding this comment

Ocramius commented Jan 5, 2016

gianarb commented Jan 5, 2016

weierophinney Jan 7, 2016

Choose a reason for hiding this comment

Ocramius Jan 8, 2016

Choose a reason for hiding this comment

weierophinney commented Jan 7, 2016

Ocramius commented Jan 13, 2016

weierophinney commented Jan 13, 2016

weierophinney commented Jan 13, 2016

Ocramius commented Jan 13, 2016