symbiote/silverstripe-phpstan

PHPStan for Silverstripe

4.0.0 2019-11-11 22:39 UTC

Requires

• php: ~7.1
• silverstripe/framework: ~4.3
• silverstripe/vendor-plugin: ^1.0

Requires (Dev)

• phpstan/phpstan: ~0.11.0
• phpstan/phpstan-phpunit: ~0.11.0
• phpunit/phpunit: ^7.5.14 || ^8.0
• squizlabs/php_codesniffer: ^3.0

Suggests

• phpstan/phpstan-shim: ~0.11.0

Replaces

• silbinarywolf/silverstripe-phpstan: 4.0.0

BSD-3-Clause

• Jake Bentvelzen

• php
• static
• silverstripe
• analysis
• scrutinizer
• PHPStan

README

An extension for PHPStan to allow it to reason about SilverStripe functionality.

Features:

• Support for DataObject::get(), ie. it understands you have a DataList of iterable SiteTree records.
• Support for DataObject db, has_one, has_many and many_many magic properties and methods, ie. it knows SiteTree::Title is a string, that SiteTree::ParentID is an integer and that SiteTree::Parent() is a SiteTree record.
• Support for singleton('SiteTree') and Injector::inst()->get('SiteTree'), ie. it knows these will return "SiteTree". If you override these with the injector, it'll also know what class you're actually using.

This PHPStan module is able to reason about extensions installed specific to your project as it bootstraps the SilverStripe config system. So if you've added an extension to your Page object that adds an additional db field, PHPStan will be able to reason about it.

Composer Install

SilverStripe 3.X

composer require --dev symbiote/silverstripe-phpstan:1.0.0 phpstan/phpstan-shim:0.9.2

SilverStripe 4.X

composer require --dev symbiote/silverstripe-phpstan:2.0.0 phpstan/phpstan-shim:~0.11.0

NOTE: We recommend installing the phpstan-shim as currently in SilverStripe 3.X, the QueuedJobs module's dependence on superclosure forces the PHP-Parser dependency of PHPStan to be at a very outdated version.

Requirements

• SilverStripe 3.1+

Documentation

• Quick Start
• Advanced Usage
• License

Known Limitations

• The type of the owner property can't be reasoned about for extensions. You must use getOwner(). Related Issues: #1043 and #1044

Credits

• Ondřej Mirtes for his amazing work on the PHPStan library
• Grant Lucas for his contribution to this library by upgrading it to PHPStan 0.9