README

NOTE: hard fork of https://github.com/studio-stomp/phpstan-craftcms

Extension for PHPStan for better support for Craft CMS. The following features are provided:

Configure autoload of Craft CMS for analysis
Stub to support different ElementQuery-classes

Install

Via Composer

$ composer require --dev sivlingworkz/phpstan-craftcms

Usage

Add phpstan-craftcms to the project phpstan.neon / phpstan.neon.dist:

includes:
    - vendor/sivlingworkz/phpstan-craftcms/extension.neon

Add the level and paths as well to the project phpstan.neon / phpstan.neon.dist:

parameters: 
    level: max # Or feel free to start at a lower level
    paths:
        - src # Common in plugins and other composer loaded packages
        - modules # Common in Craft CMS project
        - tests # Common in both

Feel free to check out the base configuration and expand on it with own configuration. For example:

includes:
    - vendor/sivlingworkz/phpstan-craftcms/extension.neon

parameters:
    ignoreErrors:
        - '#Call to an undefined method SoapClient::#'

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

sivlingworkz / phpstan-craftcms

Maintainers

Details