Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitExpert/phpstan-magento

Magento specific extension for PHPStan
https://github.com/bitExpert/phpstan-magento

magento2 php phpstan phpstan-extension

Last synced: about 1 month ago
JSON representation

Magento specific extension for PHPStan

Awesome Lists containing this project

README 

        
# bitexpert/phpstan-magento



This package provides some additional features for PHPStan to make it work for Magento 2 projects.

You can use this PHPStan extension for both Magento module projects and Magento application projects.



[![Build Status](https://github.com/bitExpert/phpstan-magento/workflows/ci/badge.svg?branch=master)](https://github.com/bitExpert/phpstan-magento/actions)

[![Coverage Status](https://coveralls.io/repos/github/bitExpert/phpstan-magento/badge.svg?branch=master)](https://coveralls.io/github/bitExpert/phpstan-magento?branch=master)

[![installs on Packagist](https://img.shields.io/packagist/dt/bitExpert/phpstan-magento)](https://packagist.org/packages/bitExpert/phpstan-magento/)

[![Mastodon Follow](https://img.shields.io/mastodon/follow/109408681246972700?domain=https://rheinneckar.social)](https://rheinneckar.social/@bitexpert)



## Requirements



PHP: PHP 7.2 or higher



Magento: Magento 2.3.0 or higher



PHPStan: PHPStan 1.12



If you are using a Magento version that requires an older version of PHPStan (e.g. 0.12.77),  you need to manually upgrade it before 

installing this extension. in your composer.json Change the PHPStan version to `~1.12` and run:



```

composer update phpstan/phpstan --with-all-dependencies

```



This PHPStan extension needs to be registered with PHPStan so that the extension gets loaded properly. The easiest way to do this is 

to install the `phpstan/extension-installer` package as follows:



```

composer.phar require --dev phpstan/extension-installer

```



  Composer Allow-Plugins configuration



If you're using Composer >= 2.2.0 you have to allow the execution of composer plugins ([see allow-plugins section](https://getcomposer.org/doc/06-config.md#allow-plugins)) as follows:



```

  - Installing phpstan/extension-installer (1.1.0): Extracting archive

phpstan/extension-installer contains a Composer plugin which is currently not in your allow-plugins config. See https://getcomposer.org/allow-plugins

Do you trust "phpstan/extension-installer" to execute code and wish to enable it now? (writes "allow-plugins" to composer.json) [y,n,d,?] y

```



## Installation



The preferred way of installing `bitexpert/phpstan-magento` is through Composer.

You can add `bitexpert/phpstan-magento` as a dev dependency, as follows:



```

composer.phar require --dev bitexpert/phpstan-magento

```



> Want a full walk-through of the installation & configuration process? Read the blog post at M.academy about [Static Analysis in Magento with PHPStan](https://m.academy/blog/static-analysis-magento-phpstan/).



### PHPStan configuration



If you have not already a PHPStan configuration file `phpstan.neon` in your project, create a new empty file next to your `composer.json` file.



See [here](https://phpstan.org/config-reference) what options PHPStan allows you to configure. 



## Feature overview



This PHPStan extension works for both Magento module projects and Magento application projects.



- Class generator for factory & proxy classes

- Mocked classes autoloader

- TestFramework autoloader

- Type hints

  - TestFramework ObjectManager type hints

  - ObjectManager type hints

- Magic method calls

- Extension attributes

- PHPStan rules

  - Service contracts

  - Resource Models should be used directly

  - Collections should be used directly via factory

  - Do not use setTemplate in Block classes

  

For a detailed overview, check the feature documentation [here](docs/features.md).



## Contribute



Please feel free to fork and extend existing or add new features and send a pull request with your changes! To establish

a consistent code quality, please provide unit tests for all your changes and adapt the documentation.



## Want To Contribute?



If you feel that you have something to share, then we’d love to have you.

Check out [the contributing guide](CONTRIBUTING.md) to find out how, as well as what we expect from you.



## License



PHPStan Magento Extension is released under the MIT License.