Download the PHP package php-static-analysis/psalm-plugin without Composer

On this page you can find all versions of the php package php-static-analysis/psalm-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of php-static-analysis/psalm-plugin

Informations about the package psalm-plugin

PHP Static Analysis Attributes Psalm Plugin

Continuous Integration Latest Stable Version License Total Downloads

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 Psalm have not made this transition to attributes and they still rely on annotations in PHPDocs for a lot of their functionality.

This is a Psalm plugin that allows Psalm to understand a new set of attributes that replace the PHPDoc annotations. These attributes are defined in this repository

NOTE: Version 0.4.0 of this plugin requires Php Parser v5. The current available version of Psalm (v5) does not support this version of the parser, so currently this library only supports the dev-master version of Psalm. If you need to use Psalm 5, you will need to use version 0.3 of this plugin.

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

First of all, to make the attributes available for your codebase use:

To use this plugin, require it in Composer:

NOTE: When adding this dependency, composer will ask you if you want to allow this dependency as a composer plugin. This is needed so that this plugin can patch Psalm in order to enable its functionality. This will add an entry in your allow-plugins composer config entry.

Then run this command to enable the plugin:

This will add this plugin configuration to the psalm.xml configuration file:

If you prefer, you can also manually add this configuration to your psalm.xml file instead of running the psalm-plugin enable command.

Using the extension

This extension works by interacting with the parser that Psalm uses to parse the code and replacing the new Attributes with PHPDoc annotations that Psalm can understand. The functionality provided by the attribute is exactly the same as the one provided by the corresponding PHPDoc annotation.

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
Immmutable @immmutable
ImportType @import-type
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
TemplateCovariant @template-covariant
TemplateExtends @extends @template-extends
TemplateImplements @implements @template-implements
TemplateUse @use @template-use
Type @var @return

Sponsor this project

If you would like to support the development of this project, please consider sponsoring me

All versions of psalm-plugin with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
composer-plugin-api Version ^2.0
ext-simplexml Version *
php-static-analysis/attributes Version ^0.4.1 || dev-main
php-static-analysis/node-visitor Version ^0.4.1 || dev-main
vimeo/psalm Version ^6
webmozart/assert Version ^1.11
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package php-static-analysis/psalm-plugin contains the following files

Loading the files please wait ....