{"id":6346,"date":"2019-08-29T19:59:19","date_gmt":"2019-08-29T14:29:19","guid":{"rendered":"http:\/\/kalilinuxtutorials.com\/?p=6346"},"modified":"2019-08-29T19:59:19","modified_gmt":"2019-08-29T14:29:19","slug":"phpstan-php-static-analysis-tool","status":"publish","type":"post","link":"https:\/\/kalilinuxtutorials.com\/phpstan-php-static-analysis-tool\/","title":{"rendered":"PHPStan – PHP Static Analysis Tool – Discover Bugs In Your Code Without Running It"},"content":{"rendered":"\n

PHPStan<\/strong> focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code. It moves PHP closer to compiled languages in the sense that the correctness of each line of the code can be checked before you run the actual line. <\/p>\n\n\n\n

Prerequisites<\/strong><\/p>\n\n\n\n

PHPStan requires PHP >= 7.1. You have to run it in environment with PHP 7.x but the actual code does not have to use PHP 7.x features. (Code written for PHP 5.6 and earlier can run on 7.x mostly unmodified.)<\/p>\n\n\n\n

PHPStan works best with modern object-oriented code. The more strongly-typed your code is, the more information you give PHPStan to work with.<\/p>\n\n\n\n

Properly annotated and typehinted code (class properties, function and method arguments, return types) helps not only static analysis tools but also other people that work with the code to understand it.<\/p>\n\n\n\n

<\/a>Installation<\/strong><\/p>\n\n\n\n

To start performing analysis on your code, require PHPStan in Composer<\/a>:<\/p>\n\n\n\n

composer require –dev phpstan\/phpstan\n<\/p>\n\n\n\n

Composer will install PHPStan’s executable in its bin-dir<\/strong><\/code> which defaults to vendor\/bin<\/strong><\/code>.<\/p>\n\n\n\n

If you have conflicting dependencies or you want to install PHPStan globally, the best way is via a PHAR archive. You will always find the latest stable PHAR archive below the release notes<\/a>. You can also use the phpstan\/phpstan-shim<\/a> package to install PHPStan via Composer without the risk of conflicting dependencies.<\/p>\n\n\n\n

You can also use PHPStan via Docker<\/a>.<\/p>\n\n\n\n

<\/a>First Run<\/strong><\/p>\n\n\n\n

To let PHPStan analyse your codebase, you have to use the analyse<\/code> command and point it to the right directories.<\/p>\n\n\n\n

So, for example if you have your classes in directories src<\/code> and tests<\/code>, you can run PHPStan like this:<\/p>\n\n\n\n

vendor\/bin\/phpstan analyse src tests<\/strong><\/p>\n\n\n\n

PHPStan will probably find some errors, but don’t worry, your code might be just fine. Errors found on the first run tend to be:<\/p>\n\n\n\n