phpstan.neon

parameters:
    bootstrapFiles:
        - bootstrap.php
    earlyTerminatingMethodCalls:
        SilverStripe\Control\Controller:
            - redirect
    universalObjectCratesClasses:
        - SilverStripe\View\ArrayData
        - SilverStripe\Core\Config\Config_ForClass
        - SilverStripe\Forms\GridField\GridState_Data
        - SilverStripe\ORM\DataObject
        - SilverStripe\ORM\DataObjectInterface
        - Symbiote\QueuedJobs\Services\AbstractQueuedJob # symbiote/silverstripe-queuedjobs module support
    excludePaths:
        - silverstripe-cache
services:
    # This adds additional methods from SilverStripe extensions, as well as determining proper
    # types when has_one() magic methods.
    -
        class: Syntro\SilverstripePHPStan\Reflection\MethodClassReflectionExtension
        tags:
            - phpstan.broker.methodsClassReflectionExtension
    # This adds additional properties from 'db', 'has_one' and other config fields to
    # determine what types are returned for magic __get's
    -
        class: Syntro\SilverstripePHPStan\Reflection\PropertyClassReflectionExtension
        tags:
            - phpstan.broker.propertiesClassReflectionExtension
    # This adds additional type info to `DataObject::get()` so that it knows what class
    # while be returned when iterating.
    -
        class: Syntro\SilverstripePHPStan\Type\DataObjectGetStaticReturnTypeExtension
        tags:
            - phpstan.broker.dynamicStaticMethodReturnTypeExtension
    # This allows `singleton("File")` calls to understand the exact classes being returned
    # by using your configuration. (ie. uses Injector information if it's set)
    -
        class: Syntro\SilverstripePHPStan\Type\SingletonReturnTypeExtension
        tags:
            - phpstan.broker.dynamicFunctionReturnTypeExtension
    # This allows `Injector::inst()->get("File")` calls to understand the exact classes being returned
    # by using your configuration. (ie. uses Injector information if it's set)
    -
        class: Syntro\SilverstripePHPStan\Type\InjectorReturnTypeExtension
        tags:
            - phpstan.broker.dynamicMethodReturnTypeExtension
    # This allows `$this->getOwner()` to understand the possible types that it could
    # return by seeing what classes are using that extension currently.
    -
        class: Syntro\SilverstripePHPStan\Type\ExtensionReturnTypeExtension
        tags:
            - phpstan.broker.dynamicMethodReturnTypeExtension
    # This makes a DataList keep it's current type information as-is when calling
    # certain functions. (So it still knows its a DataList of SiteTree objects for example)
    #
    # This will also allow "first"/"last" calls and similar to return the correct type.
    #
    -
        class: Syntro\SilverstripePHPStan\Type\DataListReturnTypeExtension
        tags:
            - phpstan.broker.dynamicMethodReturnTypeExtension
    # This makes calls to `dbObject` and `newClassInstance` return the correct type info
    -
        class: Syntro\SilverstripePHPStan\Type\DataObjectReturnTypeExtension
        tags:
            - phpstan.broker.dynamicMethodReturnTypeExtension

    -
        class: Syntro\SilverstripePHPStan\Type\FormFieldReturnTypeExtension
        tags:
            - phpstan.broker.dynamicMethodReturnTypeExtension

    # This makes calls to `DBField::create_field('HTMLText', $value)` return the correct type info
    # ie. The injectored type of the first parameter
    -
        class: Syntro\SilverstripePHPStan\Type\DBFieldStaticReturnTypeExtension
        tags:
            - phpstan.broker.dynamicStaticMethodReturnTypeExtension

    # Special handling for ->hasMethod() checks
    -
        class: Syntro\SilverstripePHPStan\Type\HasMethodTypeSpecifyingExtension
        tags:
            - phpstan.typeSpecifier.methodTypeSpecifyingExtension
    # Rule informing the user to add the @config docblock
    -
        class: Syntro\SilverstripePHPStan\Rule\ReadWriteConfigPropertiesRule
        arguments:
            alwaysWrittenTags: %propertyAlwaysWrittenTags%
            alwaysReadTags: %propertyAlwaysReadTags%
            checkUninitializedProperties: %checkUninitializedProperties%
        tags:
            - phpstan.rules.rule
    # Special handling for configuration properties
    -
        class: Syntro\SilverstripePHPStan\Reflection\ReadWritePropertiesExtension
        tags:
            - phpstan.properties.readWriteExtension