Improve documentation and types in PLL_Model #1044
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes https://github.com/polylang/polylang-pro/issues/1314.
This improves documentation in
PLL_Model
and fixes issues reported by PHPStan about types.Most of the work has been done around
PLL_Model->get_languages_list()
, by creating a new PHPStan extension.About
@phpstan-*
tags:I added several
@phpstan-param
and@phpstan-return
tags to specify types more precisely. This could have been done directly in the classic@param
and@return
tags but I prefered to keep these ones simpler and easier to read.Example, post IDs are positive integers, the integer's range is specified:
Several other fixes have been made in other files, following the changes in
PLL_Model
.PLL_Model
's tests are now usingassertSame()
instead ofassertEquals()
.Note: rollback
composer.json
once the PHPStan extension is merged into master.