Add PHPDoc annotations and PHPStan for static analysis#46
Draft
Add PHPDoc annotations and PHPStan for static analysis#46
Conversation
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add phpdoc for return types to support static analysis
Add PHPDoc annotations for static analysis tools
Jan 15, 2026
Co-authored-by: rkoopmans <1124992+rkoopmans@users.noreply.github.com>
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
Add PHPDoc annotations for static analysis tools
Add PHPDoc annotations and PHPStan for static analysis
Jan 15, 2026
| level: max | ||
| paths: | ||
| - lib | ||
| phpVersion: 50300 |
Contributor
There was a problem hiding this comment.
50300 is not supported. Minimal supported version is 70100.
| "require-dev": { | ||
| "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5 || ^7.5 || ^8.4 || ^9.3" | ||
| "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5 || ^7.5 || ^8.4 || ^9.3", | ||
| "phpstan/phpstan": "^1.0" |
Contributor
There was a problem hiding this comment.
There is a newer version, use ^2.1
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
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.
Static analysis tools like PHPStan and Psalm cannot infer types from the library's untyped methods and functions.
Changes
Added comprehensive PHPDoc annotations across all library classes:
@param) - method arguments and their types@return) - including union types (int|null,int|false) and nullable types (string|null)@throws) - all throwable exceptions documented on methods that can raise themAdded PHPStan integration for automated type checking:
phpstan/phpstan: ^1.0to dev dependenciesphpstan.neonwith max level analysis targeting thelib/directoryCoverage
lib/Tinify.php- Tinify class static methods + global helper functionslib/Tinify/Source.php- factory methods, transformation methods, output methodslib/Tinify/Result.php- result data access and file operationslib/Tinify/ResultMeta.php- metadata accessorslib/Tinify/Client.php- HTTP client request handlinglib/Tinify/Exception.php- exception factoryExample
The PHPStan integration ensures that all type annotations remain accurate and catches type-related issues automatically in CI/CD.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.