[3.0] #29 - PHP7 compliance

.php_cs

@@ -17,7 +17,6 @@ $config->fixers(
  'braces',
  'duplicate_semicolon',
  'elseif',
- 'empty_return',
  'encoding',
  'eof_ending',
  'function_call_space',

.travis.yml

@@ -27,7 +27,6 @@ matrix:
  - php: 7
  - php: hhvm 
  allow_failures:
- - php: 7
  - php: hhvm
 
 notifications:

CHANGELOG.md

@@ -2,6 +2,52 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 3.0.0 - TBD
+
+### Changed
+
+This section refers to breaking changes: please refer to
+[doc/book/zend.code.migrate.2.to.3.md](doc/book/zend.code.migrate.2.to.3.md) for migration instructions.
+
+- Types `string`, `int`, `float`, `bool` passed to `Zend\Code\Generator\ParameterGenerator#setType()`
+ are no longer ignored in generated code [#30](https://github.com/zendframework/zend-code/pull/30)
+- Types declared in DocBlocks are now ignored when creating a `Zend\Code\Generator\ParameterGenerator` via
+ `Zend\Code\Generator\ParameterGenerator::fromReflection()`. [#30](https://github.com/zendframework/zend-code/pull/30)
+- Type strings are now validated: passing an invalid type to any method in the generator API
+ may lead to a `Zend\Code\Generator\InvalidArgumentException` being thrown.
+ [#30](https://github.com/zendframework/zend-code/pull/30)
+- `Zend\Code\Generator\ParameterGenerator::$simple` was removed. [#30](https://github.com/zendframework/zend-code/pull/30)
+- `Zend\Code\Generator\ParameterGenerator#$type` is now a `null|Zend\Code\Generator\TypeGenerator`: was a
+ `string` before. [#30](https://github.com/zendframework/zend-code/pull/30)
+- `Zend\Code\Generator` type-hints are now always prefixed with the namespace separator `\`.
+ [#30](https://github.com/zendframework/zend-code/pull/30)
+- `Zend\Code\Reflection\ParameterReflection#getType()` was renamed 
+ to `Zend\Code\Reflection\ParameterReflection#detectType()` in order to not override the inherited
+ `ReflectionParameter#getType()`, introduced in PHP 7. [#30](https://github.com/zendframework/zend-code/pull/30)
+
+### Added
+
+- PHP 7 return type hints generation support via `Zend\Code\Generator\MethodGenerator#setReturnType()`.
+ [#30](https://github.com/zendframework/zend-code/pull/30)
+- PHP 7 scalar type hints generation support via `Zend\Code\Generator\ParameterGenerator#setType()` and 
+ `Zend\Code\Generator\ParameterGenerator#getType()`. [#30](https://github.com/zendframework/zend-code/pull/30)
+- PHP 5.6 variadic arguments support via `Zend\Code\Generator\ParameterGenerator#setVariadic()` and
+ `Zend\Code\Generator\ParameterGenerator#getVariadic()`. [#30](https://github.com/zendframework/zend-code/pull/30)
+- Generation of methods returning by reference is supported via `Zend\Code\Generator\ParameterGenerator#setReturnsReference()`.
+ [#30](https://github.com/zendframework/zend-code/pull/30)
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- `Zend\Code\ParameterGenerator::$simple` was removed. [#30](https://github.com/zendframework/zend-code/pull/30)
+
+### Fixed
+
+- Nothing.
+
 ## 2.7.0 - TBD
 
 ### Added

composer.json

@@ -13,14 +13,15 @@
  }
  },
  "require": {
- "php": ">=5.5",
+ "php": "^5.5 || ^7.0",
  "zendframework/zend-eventmanager": "^2.6|^3.0"
  },
  "require-dev": {
+ "ext-phar": "*",
  "doctrine/annotations": "~1.0",
  "zendframework/zend-stdlib": "~2.7",
  "fabpot/php-cs-fixer": "1.7.*",
- "phpunit/PHPUnit": "~4.0"
+ "phpunit/PHPUnit": "^4.8.21"
  },
  "suggest": {
  "doctrine/annotations": "Doctrine\\Common\\Annotations >=1.0 for annotation features",
@@ -31,7 +32,7 @@
  "extra": {
  "branch-alias": {
  "dev-master": "2.6-dev",
- "dev-develop": "2.7-dev"
+ "dev-develop": "3.0-dev"
  }
  },
  "autoload-dev": {

doc/book/zend.code.migrate.2.to.3.md

@@ -0,0 +1,131 @@
+# Migrating from `Zend\Code` `2.*` to `3.0.0`
+
+### `string`, `int`, `float`, `bool` are no longer ignored
+
+In 2.x, a `Zend\Code\Generator\ParameterGenerator` with name `foo` and type 
+`string`, `int`, `float` or `bool` simply generated code `"$foo"`:
+
+```php
+$generator = new \Zend\Code\ParameterGenerator('foo');
+
+$generator->setType('string');
+
+echo $generator->generate(); // "$foo"
+```
+
+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. The quickest way is to set the 
+type to `null`, if it matches any of these scalar types:
+
+```php
+if (in_array($type, ['string', 'int', 'float', 'bool'])) {
+ $type = null;
+}
+
+$generator->setType($type);
+```
+
+### `Zend\Code\Reflection\ParameterReflection#getType()` changes
+
+PHP 7 introduced [`ReflectionParameter#getType()`](http://php.net/manual/en/reflectionparameter.gettype.php).
+
+In order to not override this method, `Zend\Code\Reflection\ParameterReflection#getType()`
+was renamed to `Zend\Code\Reflection\ParameterReflection#detectType()`.
+
+If you relied on `Zend\Code\Reflection\ParameterReflection#getType()`, you can
+simply replace the method calls in your code.
+
+### DocBlock types ignored by `Zend\Code\Generator\ParameterGenerator::fromReflection()`
+
+As a direct consequence of the previous change, calls to 
+`Zend\Code\Generator\ParameterGenerator::fromReflection()` will not mirror the
+type hints read from a method's DocBlock.
+
+As an example, take following code:
+
+```php
+class Foo
+{
+ /**
+ * @param string $baz
+ */
+ public function bar($baz)
+ {
+ }
+}
+
+$methodGenerator = \Zend\Code\Generator\MethodGenerator::fromReflection(
+ new \Zend\Code\Reflection\MethodReflection('Foo', 'bar')
+);
+
+var_dump($methodGenerator->getParameters()[0]->getType());
+```
+
+In version 2.x, this code produces `"string"`, in version 3.x it returns `null`. If you 
+need to rely on the types in the annotations, please use
+`Zend\Code\Reflection\ParameterReflection#detectType()` instead, and build a
+`MethodGenerator` instance manually.
+
+This change is required: since signatures in PHP 7 include scalar type hints.
+That also means that reflecting scalar type hints from DocBlocks into the
+signature of a generated method may lead to fatal errors (due to signature
+mismatch) at runtime.
+
+### Type strings are validated
+
+If you attempt to generate type-hints for parameters or return types, those types are
+now validated before the code is generated.
+
+Be sure to check which values you pass to `Zend\Code\Generator\MethodGenerator#setReturnType()`
+or `Zend\Code\Generator\ParameterGenerator#setType()`, as you may incur in a
+`Zend\Code\Generator\Exception\InvalidArgumentException` being thrown if any
+of those types are invalid strings:
+
+```php
+$parameterGenerator->setType('foo'); // valid
+$parameterGenerator->setType('array'); // valid
+$parameterGenerator->setType('bool'); // valid
+$parameterGenerator->setType('123'); // invalid (throws exception)
+$parameterGenerator->setType(''); // invalid (throws exception)
+$parameterGenerator->setType('*'); // invalid (throws exception)
+$parameterGenerator->setType('\\'); // invalid (throws exception)
+```
+
+
+### Generated type-hints are now prefixed by `"\"`
+
+Generated type-hints are now prefixed with the `NAMESPACE_SEPARATOR`,
+`"\"`.
+
+Take following example code:
+
+```php
+$parameter = new \Zend\Code\Generator\ParameterGenerator('bar', 'baz');
+$method = new \Zend\Code\Generator\MethodGenerator('foo', [$parameter]);
+
+$method->setReturnType('tab');
+
+echo $method->generate();
+```
+
+This code produces `public function foo(baz $bar) {}` in 2.x.
+In version 3.x, it produces `public function foo(\baz $bar) : \tab {}`.
+
+In order to avoid migration problems, be sure to always pass fully qualified class
+names to `Zend\Code\Generator\MethodGenerator` and `Zend\Code\Generator\ParameterGenerator`.
+
+
+### `Zend\Code\Generator\ParameterGenerator::$simple` was removed
+
+If you extended `Zend\Code\Generator\ParameterGenerator`, be sure to check if you
+are accessing the protected static variable `$simple`: it was removed, and you should
+adapt your code by either copying it into your class or avoiding its usage.
+
+### `Zend\Code\Generator\ParameterGenerator::$type` has changed
+
+If you extended `Zend\Code\Generator\ParameterGenerator`, be sure to check if you
+are accessing the protected variable `$type`: its type has changed.
+While it can still be used as a string via an explicit `(string)` cast, the type of
+this protected member is now `null|Zend\Code\Generator\TypeGenerator`.

doc/bookdown.json

@@ -4,6 +4,7 @@
  "content": [
  "book/zend.code.generator.introduction.md",
  "book/zend.code.generator.reference.md",
- "book/zend.code.generator.examples.md"
+ "book/zend.code.generator.examples.md",
+ "book/zend.code.migrate.2.to.3.md"
  ]
 }

src/Generator/MethodGenerator.php

@@ -28,6 +28,16 @@ class MethodGenerator extends AbstractMemberGenerator
  */
  protected $body = null;
 
+ /**
+ * @var null|TypeGenerator
+ */
+ private $returnType;
+
+ /**
+ * @var bool
+ */
+ private $returnsReference = false;
+
  /**
  * @param MethodReflection $reflectionMethod
  * @return MethodGenerator
@@ -39,6 +49,7 @@ public static function fromReflection(MethodReflection $reflectionMethod)
 
  $method->setSourceContent($reflectionMethod->getContents(false));
  $method->setSourceDirty(false);
+ $method->setReturnType(self::extractReturnTypeFromMethodReflection($reflectionMethod));
 
  if ($reflectionMethod->getDocComment() != '') {
  $method->setDocBlock(DocBlockGenerator::fromReflection($reflectionMethod->getDocBlock()));
@@ -56,7 +67,7 @@ public static function fromReflection(MethodReflection $reflectionMethod)
 
  $method->setInterface($declaringClass->isInterface());
  $method->setStatic($reflectionMethod->isStatic());
-
+ $method->setReturnsReference($reflectionMethod->returnsReference());
  $method->setName($reflectionMethod->getName());
 
  foreach ($reflectionMethod->getParameters() as $reflectionParameter) {
@@ -258,6 +269,32 @@ public function getBody()
  return $this->body;
  }
 
+ /**
+ * @param string|null
+ *
+ * @return MethodGenerator
+ */
+ public function setReturnType($returnType = null)
+ {
+ $this->returnType = null === $returnType
+ ? null
+ : TypeGenerator::fromTypeString($returnType);
+
+ return $this;
+ }
+
+ /**
+ * @param bool $returnsReference
+ *
+ * @return MethodGenerator
+ */
+ public function setReturnsReference($returnsReference)
+ {
+ $this->returnsReference = (bool) $returnsReference;
+
+ return $this;
+ }
+
  /**
  * @return string
  */
@@ -282,7 +319,9 @@ public function generate()
 
  $output .= $this->getVisibility()
  . (($this->isStatic()) ? ' static' : '')
- . ' function ' . $this->getName() . '(';
+ . ' function '
+ . ($this->returnsReference ? '& ' : '')
+ . $this->getName() . '(';
 
  $parameters = $this->getParameters();
  if (!empty($parameters)) {
@@ -295,6 +334,10 @@ public function generate()
 
  $output .= ')';
 
+ if ($this->returnType) {
+ $output .= ' : ' . $this->returnType->generate();
+ }
+
  if ($this->isAbstract()) {
  return $output . ';';
  }
@@ -319,4 +362,28 @@ public function __toString()
  {
  return $this->generate();
  }
+
+ /**
+ * @param MethodReflection $methodReflection
+ *
+ * @return null|string
+ */
+ private static function extractReturnTypeFromMethodReflection(MethodReflection $methodReflection)
+ {
+ $returnType = method_exists($methodReflection, 'getReturnType')
+ ? $methodReflection->getReturnType()
+ : null;
+
+ if (! $returnType) {
+ return null;
+ }
+
+ $returnTypeString = (string) $returnType;
+
+ if ('self' === strtolower($returnType)) {
+ return $methodReflection->getDeclaringClass()->getName();
+ }
+
+ return $returnTypeString;
+ }
 }