Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BC BREAK: removed Scanner component, removed FileReflection, removed NameInformation and made DocBlockScanner @internal #58

Merged
merged 3 commits into from
Dec 9, 2020
Merged

BC BREAK: removed Scanner component, removed FileReflection, removed NameInformation and made DocBlockScanner @internal #58

merged 3 commits into from
Dec 9, 2020

Commits on Dec 9, 2020

  1. BC BREAK: removed Scanner component, removed FileReflection, remo… 

    …ved `NameInformation` and made `DocBlockScanner` `@internal`

The scanners were full of incomplete, untested and generally experimental code that would simply
crash when presented with something like PHP 8 code.

In addition to that, they were extremely unmaintainable due to the code being written for PHP 5,
and never being touched afterwards (too complex).

In order to slim down things and keep maintenance cost low, the complete `Laminas\Code\Scanner`
component has been trashed, with the exception of `Laminas\Code\Scanner\DocBlockScanner`, which
is still used in in some reflection internals.

It is advised for end-users to move to more modern tooling, such as [`roave/better-reflection`](https://github.com/Roave/BetterReflection)
which provides a safer (and well tested) API to scan source directories and extract reflection
information without loading any potentially dangerous PHP files.

The following components have been removed from the public API:

 * `Laminas\Code\Scanner\*`
 * `Laminas\Code\NameInformation` (unused in this package)
 * `Laminas\Code\Reflection\FileReflection` (use `roave/better-reflection` instead)
 * `Laminas\Code\Generic\Prototype\*`, which contains utilities to define custom docblock types:
   please consider using something like https://github.com/phpDocumentor/ReflectionDocBlock instead.

Signed-off-by: Marco Pivetta <[email protected]>
    @Ocramius
    Ocramius committed Dec 9, 2020
    Configuration menu
    Copy the full SHA
    b71cfb7 View commit details
    Browse the repository at this point in the history

  2. Documented BC breaks of #58 highlighted by `roave/backward-compatibil… 

    …ity-check` since `3.5.x`

See https://github.com/Roave/BackwardCompatibilityCheck

Signed-off-by: Marco Pivetta <[email protected]>
    @Ocramius
    Ocramius committed Dec 9, 2020
    Configuration menu
    Copy the full SHA
    992c26e View commit details
    Browse the repository at this point in the history

  3. Corrected or baselined static analysis issues caused by #58 `@interna… 

    …l` addition or deletions

Signed-Off-By: Marco Pivetta <[email protected]>
    @Ocramius
    Ocramius committed Dec 9, 2020
    Configuration menu
    Copy the full SHA
    ab21223 View commit details
    Browse the repository at this point in the history