Download the PHP package php-static-analysis/attributes without Composer
On this page you can find all versions of the php package php-static-analysis/attributes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download php-static-analysis/attributes
More information about php-static-analysis/attributes
Files in php-static-analysis/attributes
Package attributes
Short Description Attributes used instead of PHPDocs for static analysis tools
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package attributes
PHP Static Analysis Attributes
Since the release of PHP 8.0 more and more libraries, frameworks and tools have been updated to use attributes instead of annotations in PHPDocs.
However, static analysis tools like PHPStan or Psalm or IDEs like PhpStorm or VS Code have not made this transition to attributes and they still rely on annotations in PHPDocs for a lot of their functionality.
This library aims to provide a set of PHP attributes which could replace the most commonly used annotations accepted by these tools and will aim to provide related repositories with the extensions or plugins that would allow these attributes to be used in these tools.
In particular, these repositories are:
Example
In order to show how code would look with these attributes, we can look at the following example. This is how a class looks like with the current annotations:
And this is how it would look like using the new attributes:
Installation
To use these attributes, require this library in Composer:
And then install any needed extensions/plugins for the tools that you use.
List of implemented attributes
These are the available attributes and their corresponding PHPDoc annotations:
| Attribute | PHPDoc Annotations |
|---|---|
| Assert | @assert |
| AssertIfFalse | @assert-if-false |
| AssertIfTrue | @assert-if-true |
| DefineType | @type |
| Deprecated | @deprecated |
| Immutable | @immutable |
| ImportType | @import-type |
| Impure | @impure |
| Internal | @internal |
| IsReadOnly | @readonly |
| Method | @method |
| Mixin | @mixin |
| Param | @param |
| ParamOut | @param-out |
| Property | @property @var |
| PropertyRead | @property-read |
| PropertyWrite | @property-write |
| Pure | @pure |
| RequireExtends | @require-extends |
| RequireImplements | @require-implements |
| Returns | @return |
| SelfOut | @self-out @this-out |
| Template | @template |
| TemplateContravariant | @template-contravariant |
| TemplateCovariant | @template-covariant |
| TemplateExtends | @extends @template-extends |
| TemplateImplements | @implements @template-implements |
| TemplateUse | @use @template-use |
| Throws | @throws |
| Type | @var @return @type |
PhpStorm Support
A plugin that fully supports these attributes will need to be created. Until this is ready you can get partial support by installing PHPStan, our PHPStan extension and enabling PHPStan support in PhpStorm (as described here). You will then be able to see errors and messages related to these attributes in your code.
Alternatively install Psalm, our Psalm extension and enable Psalm support in PhpStorm (as described here)
VS Code Support
An extension that fully supports these attributes will need to be created. Until this is ready you can get partial support by installing PHPStan, our PHPStan extension and a VS Code extension that supports PHPStan (for example this one). When you enable the extension you will be able to see errors and messages related to these attributes in your code.
Alternatively install Psalm, our Psalm extension and a VS Code extension that supports Psam (for example this one)
Sponsor this project
If you would like to support the development of this project, please consider sponsoring me
