Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.92 KB

phpstan.md

File metadata and controls

47 lines (34 loc) · 1.92 KB
Raw

Static code analysis (PHPStan)

Find bugs before they reach production. Static code analysis is executed using PHPStan. A file called phpstan.neon is added during the installation of the testing suite and can be customized per project / repository.

PHPStan

Tips & Tricks

First of all, there is always a reason some code should be ignored. Please make sure to always document that reason, either in a comment or a commit message.

You can work around this by ignoring these in phpstan.neon

PHPStan will not recognize magic methods, e.g.

------ ------------------------------------------------------------------------------------- 
  Line   app/code/YourProject/Rma/ViewModel/Guest.php                                          
 ------ ------------------------------------------------------------------------------------- 
  130    Call to an undefined method Magento\Framework\App\RequestInterface::getPostValue().  
 ------ -------------------------------------------------------------------------------------

The best way to work around this would be adding this entry to phpstan.neon

    - message: '#Call to an undefined method Magento\\Framework\\App\\RequestInterface::getPostValue\(\)#'
      path: app/code/YourProject/Rma/ViewModel/Guest.php

A less sophisticated workaround would be ignoring a single line. Make sure to add a comment though, so others are aware of what exactly should be ignored. Unfortunately PHPStan does not support ignoring specific errors in inline comments.

<?php
/** @phpstan-ignore-next-line Ignore magic method getPostValue */
$post = $request->getPostValue();

Magento 2

For Magento 2 projects the BitExpert PHPstan-magento module is installed. Check out this page for a full list of features.