Issue #415: Increased PHPStan level to 8
#421
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: alexmerlin <[email protected]>
Signed-off-by: alexmerlin <[email protected]>
Signed-off-by: alexmerlin <[email protected]>
Signed-off-by: alexmerlin <[email protected]>
arhimede
approved these changes
May 9, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR increases the PHPStan analysis level to 8 and enhances type annotations and PHPDoc comments across exception classes, config providers, and service interfaces while also adding minor input sanitation improvements.
- Increase PHPStan level in phpstan.neon
- Update PHPDoc types (using non-empty-string, non-empty-array, etc.) in exception classes, service interfaces, and config providers
- Introduce input trimming in AdminCreateCommand for more robust input handling
Reviewed Changes
Copilot reviewed 103 out of 103 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/App/src/Exception/SunsetException.php | Updated to extend Exception and implement ProblemDetailsExceptionInterface, including a new create() method with a status set to STATUS_UNAUTHORIZED |
| src/App/src/Exception/RuntimeException.php | Added PHPDoc documentation for the create() method |
| src/App/src/Exception/*.php | Similar PHPDoc type enhancements applied to various exception classes |
| src/App/src/ConfigProvider.php | Added detailed PHPStan type annotations for collections and dependencies |
| src/App/src/Attribute/BaseDeprecation.php | Updated to use the new factory method for throwing SunsetException |
| src/Admin/src/Service/* | Adjusted PHPDoc types for input arrays on service interfaces and implementations |
| src/Admin/src/Handler/* | Updated input filtering to assign a trimmed data array before passing to service methods |
| src/Admin/src/ConfigProvider.php | Enhanced PHPStan type documentation for Hal metadata and dependencies |
| src/Admin/src/Command/AdminCreateCommand.php | Added the trim() function for input options and improved PHPDoc for expected data structure |
| phpstan.neon | Increased analysis level from 5 to 8 |
Comments suppressed due to low confidence (1)
src/App/src/Exception/SunsetException.php:26
- Consider verifying that using STATUS_UNAUTHORIZED is appropriate for a sunset exception. Typically, sunset or deprecation semantics might be better reflected by a status such as 410 (Gone) to more accurately indicate that the resource is no longer available.
$exception->status = StatusCodeInterface::STATUS_UNAUTHORIZED;
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.