5.5.0

What's Changed

Improved method tag parameter rendering, by now the method tag parameters are correctly rendered when transforming a docblock back to string.

New supported tags:

• @template
• @template-covariant
• @mixin
• @implements & @template-implements
• @extends & @template-extends

The template tags do not support all functionality needed to have full generic support as this requires some extra work. But for many situations this will already add value.

related pr's:

• Fix typos by @szepeviktor in #371
• Add new tags by @ahjdev in #373
• Build on php 8.4 by @jaapio in #375
• method parameter default value rendering by @GautierDele in #374

New Contributors

• @szepeviktor made their first contribution in #371
• @ahjdev made their first contribution in #373
• @GautierDele made their first contribution in #374

Full Changelog: 5.4.1...5.5.0

5.4.1

Address multiple bugs with long tag descriptions

In the previous release a regression was introduced regarding multiline tag descriptions. Part of the description was lost and the indenting wasn't reduced as we did before 5.4. If your application relies on docblock tags and uses the descriptions it is highly recommended to update immediately. And block version 5.4.0 from the allowed versions in your composer.json

   "conflict":
      "phpdocumentor/reflection-docblock": "5.4.0"

Thanks to #365 by @szepeviktor and @IanDelMar

• Bugfix: resolve issue with multiline descriptions by @jaapio in #367
• Bugfix: docblock tag descriptions by @jaapio in #370

Full Changelog: 5.4.0...5.4.1

5.4.0

More type support

Since the beginning of this package we have been working on our own parser. Mostly regular expressions spitting each part of a docblock and processing them separately in each tag. But since static analyzers became more popular it became a lot harder to cover all the new formats of types. In type-resolver 1.7 we already started using phpstan's parser to process types. And now in this release we also cover parts of the docblock parsing process with their parser. This will make it easier to keep up with all the new changes and allows us to support more complex type formats.

We do not support all types covered by phpstan. Generics are not fully supported on all notations, we will return an InvalidTag in those cases.

Deprecations

Param tag

We spend a lot of time to cover all the edge cases that we supported in docblocks for many years. However we also noticed that some notations do not really make sense. First notation added to the list is a @param tag without a variable.

@param MyType Here starts the description but $var is ommited

This notation is now deprecated, and support will be removed in the first release of v6.

Static factory interface

We introduced a new factory strategy to make it possible to have more complex factories for tags and keep the implementation simple. Due to this new system of creating tags we can now support external parser to cover the body of a tag to be handled. With this new system the older system of StaticFactories has become deprecated. And will be removed in v6.

Backward compatibility

We introduced all new functionality with backward compatibility in mind. There are no interface changes being made so consumers of the library will not notice anything from the internal changes. However since we introduced a large amount of new types you might notice issues depending on your implementation. Especially when your project reads the types provided by this library.

Other notable changes

• Fix PhpDoc in class Description by @WinterSilence in #317
• Optimize Description::render() by @WinterSilence in #318
• Test with multiple versions of the dependencies by @villfa in #319
• GH Actions: version update for ramsey/composer-install by @jrfnl in #321
• Send code coverage to Scrutinizer by @villfa in #320
• GH Actions: version update for various predefined actions by @jrfnl in #329
• Support reference in method tag by @villfa in #332
• Upgrade ci to standardized pipeline by @jaapio in #340
• PhpStan based tag parsing by @jaapio in #343
• Update .gitattributes by @williamdes in #344
• Test against php 8.3 by @sergiy-petrov in #356
• Fix rendering a description when it contains escaped chars and no tags by @AydinHassan in #357
• Add typeless parameter support. by @jaapio in #360
• Be more strict about type definitions on param by @jaapio in #363
• Added test for regression on invalid types by @jaapio in #364

New Contributors

• @WinterSilence made their first contribution in #317
• @williamdes made their first contribution in #344
• @sergiy-petrov made their first contribution in #356
• @AydinHassan made their first contribution in #357

Full Changelog: 5.3.0...5.4.0

5.3.0

Added

• Get tags with type by name by @voku in #260

Deprecated

• Nothing

Fixed

• Tests: fix typo in test method name by @jrfnl in #279
• Tests: fix incorrect namespace by @jrfnl in #280
• Docblock/Tags/Author: fix typo in method docblock by @jrfnl in #283
• Tests: fix missing @covers tag by @jrfnl in #286
• Tests: mark test without assertions as such by @jrfnl in #285
• GH Actions: allow for manually triggering a workflow by @jrfnl in #281
• GH Actions: simplify Composer caching by @jrfnl in #282
• Composer: fix autoload-dev directive by @jrfnl in #289
• DocBlock/Tags/Source: remove redundant code by @jrfnl in #288
• Improve line-endings for windows. by @jaapio in #296
• Fix undefined index by @villfa in #298
• PHPUnit: update configuration by @jrfnl in #303
• Phive: upgrade used version of PHPUnit by @jrfnl in #292
• Remove deprecated StaticMethod and fix comment by @kea in #306

Removed

• Nothing

Security

• Nothing

New Contributors

• @jrfnl made their first contribution in #279
• @villfa made their first contribution in #298
• @kea made their first contribution in #306

Full Changelog: 5.2.2...5.3.0

5.2.2

Added

• Nothing

Deprecated

• Nothing

Fixed

• Update Link.php #239, thanks to @Kasp42
• Param: fix phpdoc with reference hint #253, thanks to @voku
• Do not resolve types if it's not possible #254, thanks to @voku

Removed

• Nothing

Security

• Nothing

5.2.1

Added

• Nothing

Deprecated

• Nothing

Fixed

• InvalidTag::flattenExceptionBacktrace() corrupts reference arguments #249, thanks to @nikic
• Fix modified backtrace #250, thanks to @jaapio

Removed

• Nothing

Security

• Nothing

5.2.0

Added

• php 8 support, #240 thanks to @DerManoMann
• improved php8 support, #242 thanks to @GrahamCampbell

Deprecated

• Nothing

Fixed

• Nothing

Removed

• Nothing

Security

• Nothing

5.1.0

Added

• Improved psalm support, #212 thanks to @orklah
• BC check, thanks to @jaapio

Deprecated

• StaticMethod interface, #211 thanks to @orklah

Fixed

• ensure 'args' exist in trace, #202 thanks to @drupol
• don't rely on 'args' in trace, not available in 7.4, #205 thanks to @remicollet
• Restore support for long @method names, #203 thanks to @danrot and @rvanvelzen

Removed

• Nothing

Security

• Nothing

5.0.0

Added

• Support for tag specialization as described in PRS-5 using :, thanks to @jaapio

Deprecated

• Nothing

Fixed

• restore [ to be allowed as the first character of tag body, thanks to @jaapio

Removed

• Nothing

Security

• Nothing

5.0.0-beta

Added

• Nothing

Deprecated

• Nothing

Fixed

• Fix invalid return of null in standard tag factory, thanks to @jaapio

Removed

• Nothing

Security

• Nothing