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-installby @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
