PHPStan for Silverstripe
An extension for PHPStan to allow it to reason about SilverStripe functionality.
- Support for
DataObject::get(), ie. it understands you have a DataList of iterable SiteTree records.
- Support for DataObject
many_manymagic 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
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 require --dev symbiote/silverstripe-phpstan:1.0.0 phpstan/phpstan-shim:0.9.2
composer require --dev symbiote/silverstripe-phpstan:2.0.0 phpstan/phpstan-shim:0.9.2
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.
- SilverStripe 3.1+
- The type of the
ownerproperty can't be reasoned about for extensions. You must use
getOwner(). Related Issues: #1043 and #1044