[Summary view] [Print] [Text view]

   1  # Changelog
   2  
   3  All notable changes to this project will be documented in this file, in reverse chronological order by release.
   4  
   5  ## 3.4.1 - 2019-12-10
   6  
   7  ### Added
   8  
   9  - [#180](https://github.com/zendframework/zend-code/pull/180) adds support for PHP 7.4.
  10  
  11  ### Changed
  12  
  13  - Nothing.
  14  
  15  ### Deprecated
  16  
  17  - Nothing.
  18  
  19  ### Removed
  20  
  21  - Nothing.
  22  
  23  ### Fixed
  24  
  25  - [#179](https://github.com/zendframework/zend-code/pull/179) fixes exception message when invalid value provided in `Zend\Code\Generator\ValueGenerator`.
  26  
  27  - [#180](https://github.com/zendframework/zend-code/pull/190) fixes PHP 7.4 compatibility.
  28  
  29  ## 3.4.0 - 2019-10-06
  30  
  31  ### Added
  32  
  33  - [#170](https://github.com/zendframework/zend-code/pull/170) adds class constant visibility modifiers support.
  34  
  35  - [#169](https://github.com/zendframework/zend-code/pull/169) adds the ability to define declare statements.
  36  
  37  - [#167](https://github.com/zendframework/zend-code/pull/167) adds the ability to remove doc block of a member.
  38  
  39  ### Changed
  40  
  41  - [#166](https://github.com/zendframework/zend-code/pull/166) changes omitting default property value if it is null.
  42  
  43  ### Deprecated
  44  
  45  - Nothing.
  46  
  47  ### Removed
  48  
  49  - Nothing.
  50  
  51  ### Fixed
  52  
  53  - [#172](https://github.com/zendframework/zend-code/pull/172) fixes PHP 7.4 compatibility.
  54  
  55  ## 3.3.2 - 2019-08-31
  56  
  57  ### Added
  58  
  59  - [#162](https://github.com/zendframework/zend-code/pull/162) adds support for PHP 7.3.
  60  
  61  ### Changed
  62  
  63  - Nothing.
  64  
  65  ### Deprecated
  66  
  67  - Nothing.
  68  
  69  ### Removed
  70  
  71  - Nothing.
  72  
  73  ### Fixed
  74  
  75  - [#171](https://github.com/zendframework/zend-code/pull/171) changes
  76    curly braces in array and string offset access to square brackets
  77    in order to prevent issues under the upcoming PHP 7.4 release.
  78  
  79  - [#164](https://github.com/zendframework/zend-code/pull/164) fixes indentation in multi-level arrays generated by `ValueGenerator`.
  80  
  81  ## 3.3.1 - 2018-08-13
  82  
  83  ### Added
  84  
  85  - Nothing.
  86  
  87  ### Changed
  88  
  89  - Nothing.
  90  
  91  ### Deprecated
  92  
  93  - Nothing.
  94  
  95  ### Removed
  96  
  97  - Nothing.
  98  
  99  ### Fixed
 100  
 101  - [#158](https://github.com/zendframework/zend-code/pull/158) updates several `switch` cases to use `break` instead of `continue`
 102    in order to prevent issues under the upcoming PHP 7.3 release.
 103  
 104  - [#147](https://github.com/zendframework/zend-code/pull/147) fixes the regular expression used for `@var` annotations to
 105    allow omission of the variable name.
 106  
 107  - [#146](https://github.com/zendframework/zend-code/pull/146) updates all `@return` annotations to reflect the correct types returned by each method.
 108  
 109  - [#144](https://github.com/zendframework/zend-code/pull/144) fixes the class generator such that it now resolves
 110    `setExtendedClass()` arguments to aliases provided to the generator.
 111  
 112  - [#140](https://github.com/zendframework/zend-code/pull/140) fixes `MethodScanner::setVisibility()` such that it no longer
 113    casts the provided visibility token to lower case; this fix is necessary, as
 114    the method is supposed to expect only the appropriate
 115    `T_(PUBLIC|PROTECTED|PRIVATE)` token values, which are integers.
 116  
 117  - [#140](https://github.com/zendframework/zend-code/pull/140) updates the `MethodScanner::setVisibility()` method to raise
 118    a package-specific `InvalidArgumentException` instead of the non-existent
 119    package `Exception` class when an invalid visibility is provided.
 120  
 121  ## 3.3.0 - 2017-10-20
 122  
 123  ### Added
 124  
 125  - [#131](https://github.com/zendframework/zend-code/pull/131) added the
 126    ability to omit a parameter type declaration
 127  - [#132](https://github.com/zendframework/zend-code/pull/132) added a
 128    lightweight `MethodGenerator::copyMethodSignature()` constructor that
 129    only copies the method declaration with no body nor docblock.
 130  - [#134](https://github.com/zendframework/zend-code/pull/134) short array
 131    notation is now used by default for generated array values
 132  - [#136](https://github.com/zendframework/zend-code/pull/136) added the
 133    ability to specify an `omitdefaultvalue` key when using
 134    `ParameterGenerator::fromArray()`
 135  
 136  ### Deprecated
 137  
 138  - Nothing.
 139  
 140  ### Removed
 141  
 142  - Nothing.
 143  
 144  ### Fixed
 145  
 146  - [#130](https://github.com/zendframework/zend-code/pull/130) Updated 
 147    links to the documentation
 148  - [#133](https://github.com/zendframework/zend-code/pull/133) The default
 149    value of a `ParameterGenerator` is always a `ValueGenerator`
 150  
 151  ## 3.2.0 - 2017-07-23
 152  
 153  ### Added
 154  
 155  - [#112](https://github.com/zendframework/zend-code/pull/112)
 156    [#110](https://github.com/zendframework/zend-code/pull/110) Introduced
 157    support for the PHP `7.2` `object` type-hint
 158  - [#41](https://github.com/zendframework/zend-code/pull/41) Added `VarTag`
 159    support to the docblock generators and reflectors: allows generating
 160    and parsing `@var` tags.
 161  - [#113](https://github.com/zendframework/zend-code/pull/113) Added
 162    PHP `7.2` to the build matrix
 163  - [#114](https://github.com/zendframework/zend-code/pull/114) Increased
 164    minimum supported PHP version to `^7.1.0`
 165  - [#114](https://github.com/zendframework/zend-code/pull/114) Upgraded
 166    PHPUnit dependency to `^6.2.2`
 167  - [#121](https://github.com/zendframework/zend-code/pull/121) Imported
 168    global functions via `use` statements (experimenting with OpCache
 169    OPCODE inlining optimisations)
 170  
 171  ### Deprecated
 172  
 173  - Nothing.
 174  
 175  ### Removed
 176  
 177  - [#113](https://github.com/zendframework/zend-code/pull/113)
 178    [#118](https://github.com/zendframework/zend-code/pull/118) Removed
 179    HHVM support
 180  - [#122](https://github.com/zendframework/zend-code/pull/122) Removed
 181    IRC notifications for pushes/build statuses
 182  
 183  ### Fixed
 184  
 185  - [#101](https://github.com/zendframework/zend-code/pull/101) avoid
 186    calling `isInternalPhpType` twice in the `TypeGenerator`
 187  - [#115](https://github.com/zendframework/zend-code/pull/115) Replaced
 188    assertions in the test suite with their static counterparts where
 189    applicable
 190  - [#120](https://github.com/zendframework/zend-code/pull/120)
 191    [#109](https://github.com/zendframework/zend-code/pull/109)
 192    [#100](https://github.com/zendframework/zend-code/pull/100) Applied
 193    ZendFramework coding standard to the library code
 194  - [#119](https://github.com/zendframework/zend-code/pull/119) Corrected
 195    test suite errors caused by mismatching parameter order
 196  - [#106](https://github.com/zendframework/zend-code/pull/106)
 197  - [#107](https://github.com/zendframework/zend-code/pull/107) Minor
 198    typing error corrections in documentation and error messages
 199  
 200  ## 3.1.0 - 2016-10-24
 201  
 202  ### Added
 203  
 204  - [#87](https://github.com/zendframework/zend-code/pull/87) support for
 205    PHP 7.1's `void` return type declaration.
 206  - [#87](https://github.com/zendframework/zend-code/pull/87) support for
 207    PHP 7.1's nullable type declarations.
 208  - [#87](https://github.com/zendframework/zend-code/pull/87) support for
 209    PHP 7.1's `iterable` type declaration.
 210  - [#62](https://github.com/zendframework/zend-code/pull/62) added
 211    `Zend\Code\Generator\MethodGenerator#getReturnType()` accessor.
 212  - [#68](https://github.com/zendframework/zend-code/pull/68)
 213    [#26](https://github.com/zendframework/zend-code/pull/26) added mutators
 214    to allow removing/checking for existence of methods, properties, constants,
 215    parameters and type declarations across all the code generator API.
 216  - [#65](https://github.com/zendframework/zend-code/pull/65) continuous
 217    integration testing now checks locked, newest and oldest dependency
 218    sets.
 219  
 220  ### Deprecated
 221  
 222  - Nothing.
 223  
 224  ### Removed
 225  
 226  - Nothing.
 227  
 228  ### Fixed
 229  
 230  - Nothing.
 231  
 232  ## 3.0.5 - 2016-10-24
 233  
 234  ### Added
 235  
 236  - Nothing.
 237  
 238  ### Deprecated
 239  
 240  - Nothing.
 241  
 242  ### Removed
 243  
 244  - Nothing.
 245  
 246  ### Fixed
 247  
 248  - [#92](https://github.com/zendframework/zend-code/pull/92) corrected
 249    `Zend\Code\Scanner\ClassScanner` to detect multiple interface inheritance.
 250  - [#95](https://github.com/zendframework/zend-code/pull/95) corrected
 251    `Zend\Code\Generator\ParameterGenerator` to allow copying parameter signatures
 252    for non-optional parameters that are still nullable via a default `= null`
 253    value.
 254  - [#94](https://github.com/zendframework/zend-code/pull/94) corrected
 255    `Zend\Code\Generator\ValueGenerator` so that class constants can now
 256    be generated with arrays as default value (supported since PHP 5.6).
 257  
 258  ## 3.0.4 - 2016-06-30
 259  
 260  ### Added
 261  
 262  - Nothing.
 263  
 264  ### Deprecated
 265  
 266  - Nothing.
 267  
 268  ### Removed
 269  
 270  - Nothing.
 271  
 272  ### Fixed
 273  
 274  - [#59](https://github.com/zendframework/zend-code/pull/59) fixes an issue with
 275    detection of multiple trait `use` statements.
 276  - [#75](https://github.com/zendframework/zend-code/pull/75) provides a patch to
 277    ensure that `extends` statements qualify the parent class based on the current
 278    namespace and/or import statements.
 279  
 280  ## 3.0.3 - 2016-06-27
 281  
 282  ### Added
 283  
 284  - [#66](https://github.com/zendframework/zend-code/pull/66) publishes the
 285    documentation to https://docs.zendframework.com/zend-code/.
 286  
 287  ### Deprecated
 288  
 289  - Nothing.
 290  
 291  ### Removed
 292  
 293  - Nothing.
 294  
 295  ### Fixed
 296  
 297  - [#61](https://github.com/zendframework/zend-code/pull/61) fixes an issue with
 298    how parameter typehints were generated; previously, fully-qualified class
 299    names were not being generated with the leading backslash, causing them to
 300    attempt to resolve as if they were relative to the current namespace.
 301  - [#69](https://github.com/zendframework/zend-code/pull/69) fixes an issue with
 302    how class names under the same namespace are generated when generating
 303    typehints, extends, and implements values; they now strip the
 304    common namespace from the class name.
 305  - [#72](https://github.com/zendframework/zend-code/pull/72) fixes an issue
 306    within the `TokenArrayScanner` when scanning closures.
 307  
 308  ## 3.0.2 - 2016-04-20
 309  
 310  ### Added
 311  
 312  - Nothing.
 313  
 314  ### Deprecated
 315  
 316  - Nothing.
 317  
 318  ### Removed
 319  
 320  - Nothing.
 321  
 322  ### Fixed
 323  
 324  - [#52](https://github.com/zendframework/zend-code/pull/52) updates several
 325    dependency constraints:
 326    - zend-stdlib now allows either the 2.7 or 3.0 series, as the APIs consumed by
 327      zend-code are compatible across versions.
 328    - PHP now excludes the 7.0.5 release, as it has known issues in its tokenizer
 329      implementation that make the zend-code token scanner unusable.
 330  - [#46](https://github.com/zendframework/zend-code/pull/46) updates all
 331    generators to use `\n` for line endings in generated code, vs `PHP_EOL`,
 332    ensuring cross-platform consistency.
 333  
 334  ## 3.0.1 - 2016-01-26
 335  
 336  ### Added
 337  
 338  - Nothing.
 339  
 340  ### Deprecated
 341  
 342  - Nothing.
 343  
 344  ### Removed
 345  
 346  - Nothing.
 347  
 348  ### Fixed
 349  
 350  - [#34](https://github.com/zendframework/zend-code/pull/34) method name cannot be optional when adding a method
 351    to a class generator.
 352  - [#38](https://github.com/zendframework/zend-code/pull/38) PHP_CodeSniffer was moved to dev dependencies
 353  
 354  ## 3.0.0 - 2016-01-13
 355  
 356  ### Changed
 357  
 358  - [#140](https://github.com/zendframework/zend-code/pull/140) updates the `MethodScanner::setVisibility()` method to raise a package-specific `InvalidArgumentException` instead of
 359    the non-existent package `Exception` class when an invalid visibility is provided.
 360  
 361  This section refers to breaking changes: please refer to
 362  [docs/book/migration.md](docs/book/migration.md) for migration instructions.
 363  
 364  - Types `string`, `int`, `float`, `bool` passed to `Zend\Code\Generator\ParameterGenerator#setType()`
 365    are no longer ignored in generated code [#30](https://github.com/zendframework/zend-code/pull/30)
 366  - Types declared in DocBlocks are now ignored when creating a `Zend\Code\Generator\ParameterGenerator` via
 367    `Zend\Code\Generator\ParameterGenerator::fromReflection()`. [#30](https://github.com/zendframework/zend-code/pull/30)
 368  - Type strings are now validated: passing an invalid type to any method in the generator API
 369    may lead to a `Zend\Code\Generator\InvalidArgumentException` being thrown.
 370    [#30](https://github.com/zendframework/zend-code/pull/30)
 371  - `Zend\Code\Generator\ParameterGenerator::$simple` was removed. [#30](https://github.com/zendframework/zend-code/pull/30)
 372  - `Zend\Code\Generator\ParameterGenerator#$type` is now a `null|Zend\Code\Generator\TypeGenerator`: was a
 373    `string` before. [#30](https://github.com/zendframework/zend-code/pull/30)
 374  - `Zend\Code\Generator` type-hints are now always prefixed with the namespace separator `\`.
 375    [#30](https://github.com/zendframework/zend-code/pull/30)
 376  - `Zend\Code\Reflection\ParameterReflection#getType()` was renamed 
 377    to `Zend\Code\Reflection\ParameterReflection#detectType()` in order to not override the inherited
 378    `ReflectionParameter#getType()`, introduced in PHP 7. [#30](https://github.com/zendframework/zend-code/pull/30)
 379  
 380  ### Added
 381  
 382  - PHP 7 return type hints generation support via `Zend\Code\Generator\MethodGenerator#setReturnType()`.
 383    [#30](https://github.com/zendframework/zend-code/pull/30)
 384  - PHP 7 scalar type hints generation support via `Zend\Code\Generator\ParameterGenerator#setType()` and 
 385    `Zend\Code\Generator\ParameterGenerator#getType()`. [#30](https://github.com/zendframework/zend-code/pull/30)
 386  - PHP 5.6 variadic arguments support via `Zend\Code\Generator\ParameterGenerator#setVariadic()` and
 387    `Zend\Code\Generator\ParameterGenerator#getVariadic()`. [#30](https://github.com/zendframework/zend-code/pull/30)
 388  - Generation of methods returning by reference is supported via `Zend\Code\Generator\ParameterGenerator#setReturnsReference()`.
 389    [#30](https://github.com/zendframework/zend-code/pull/30)
 390  
 391  ### Deprecated
 392  
 393  - Nothing.
 394  
 395  ### Removed
 396  
 397  - `Zend\Code\ParameterGenerator::$simple` was removed. [#30](https://github.com/zendframework/zend-code/pull/30)
 398  
 399  ### Fixed
 400  
 401  - Nothing.
 402  
 403  ## 2.6.2 - 2015-01-05
 404  
 405  ### Added
 406  
 407  - Nothing.
 408  
 409  ### Deprecated
 410  
 411  - Nothing.
 412  
 413  ### Removed
 414  
 415  - Nothing.
 416  
 417  ### Fixed
 418  
 419  - [#31](https://github.com/zendframework/zend-code/pull/31) updated license year.
 420  
 421  ## 2.6.2 - 2015-01-05
 422  
 423  ### Added
 424  
 425  - Nothing.
 426  
 427  ### Deprecated
 428  
 429  - Nothing.
 430  
 431  ### Removed
 432  
 433  - Nothing.
 434  
 435  ### Fixed
 436  
 437  - [#31](https://github.com/zendframework/zend-code/pull/31) updated license year.
 438  
 439  ## 2.6.1 - 2015-11-24
 440  
 441  ### Added
 442  
 443  - Nothing.
 444  
 445  ### Deprecated
 446  
 447  - Nothing.
 448  
 449  ### Removed
 450  
 451  - Nothing.
 452  
 453  ### Fixed
 454  
 455  - [#25](https://github.com/zendframework/zend-code/pull/25) changes the
 456    `doctrine/common` suggestion/dev-dependency to the more specific
 457    `doctrine/annotations` package (which is what is actually consumed).
 458  
 459  ## 2.6.0 - 2015-11-18
 460  
 461  ### Added
 462  
 463  - [#12](https://github.com/zendframework/zend-code/pull/12) adds the ability to
 464    generate arrays using either long/standard syntax (`array(...)`) or short
 465    syntax (`[...]`). This can be accomplished by setting the value type to
 466    `ValueGenerator::TYPE_ARRAY_SHORT` instead of using `TYPE_ARRAY`.
 467    Additionally, you can use `TYPE_ARRAY_LONG` instead of `TYPE_ARRAY`; the two
 468    constants are synonyms.
 469  - [#11](https://github.com/zendframework/zend-code/pull/11) adds the ability to
 470    generate interfaces via the new class `Zend\Code\Generator\InterfaceGenerator`.
 471  
 472  ### Deprecated
 473  
 474  - Nothing.
 475  
 476  ### Removed
 477  
 478  - Nothing.
 479  
 480  ### Fixed
 481  
 482  - [#20](https://github.com/zendframework/zend-code/pull/20) updates
 483    the zend-eventmanager dependency to `^2.6|^3.0`, and changes its
 484    internal usage to use the `triggerEventUntil()` signature.
 485  
 486  ## 2.5.3 - 2015-11-18
 487  
 488  ### Added
 489  
 490  - Nothing.
 491  
 492  ### Deprecated
 493  
 494  - Nothing.
 495  
 496  ### Removed
 497  
 498  - [#10](https://github.com/zendframework/zend-code/pull/10) removes a
 499    development dependency on zendframework/zend-version.
 500  - [#23](https://github.com/zendframework/zend-code/pull/23) removes a
 501    requirement on zendframework/zend-stdlib. This results in a slight change in
 502    `Zend\Code\Generator\ValueGenerator`: `setConstants()` and `getConstants()`
 503    can now receive/emit *either* an SPL `ArrayObject` or
 504    `Zend\Stdlib\ArrayObject`. Since these are functionally equivalent, however,
 505    you will experience no change in behavior.
 506  
 507  ### Fixed
 508  
 509  - Nothing.