phpstan.neon.dist

includes:
    - phpstan-baseline.neon
    - vendor/phpstan/phpstan/conf/bleedingEdge.neon

parameters:
    phpVersion: 80100
    level: 8
    treatPhpDocTypesAsCertain: false
    checkMissingIterableValueType: true
    inferPrivatePropertyTypeFromConstructor: true
    reportUnmatchedIgnoredErrors: true # Could be set to false if necessary during PHPStan update
    tmpDir: var/cache/phpstan
    paths:
        - src
        - tests

    bootstrapFiles:
        - src/Core/DevOps/StaticAnalyze/PHPStan/phpstan-bootstrap.php
    # run `php src/Core/DevOps/StaticAnalyze/PHPStan/phpstan-bootstrap.php` to create the container
    symfony:
        constantHassers: false
        containerXmlPath: 'var/cache/phpstan_dev/Shopware_Core_DevOps_StaticAnalyze_StaticAnalyzeKernelPhpstan_devDebugContainer.xml'
        consoleApplicationLoader: src/Core/DevOps/StaticAnalyze/PHPStan/console-application.php

    excludePaths:
        - src/WebInstaller/src/Resources/
        - src/WebInstaller/ecs.php
        - src/WebInstaller/vendor
        - src/WebInstaller/tests/_fixtures

        - src/Core/DevOps/StaticAnalyze/Rector/ClassPackageRector.php
        # Compatibility fixes for doctrine annotation parser https://github.com/doctrine/annotations/issues/421
        - src/Core/Framework/Compatibility/AnnotationReader.php
        - src/Core/Framework/Compatibility/DocParser.php

        # Symfony interface typehints `Predis\ClientInterface` which is by default not available
        - src/Core/Framework/Adapter/Cache/ShopwareRedisAdapter.php
        - src/Core/Framework/Adapter/Cache/ShopwareRedisTagAwareAdapter.php

        # node_modules
        - src/**/node_modules/*
        - tests/**/node_modules/*

        # twig override
        - src/Core/Framework/Adapter/Twig/functions.php

        # class behind feature flags
        - src/Core/Checkout/Cart/Exception/InvalidCartException.php

        # extends final class, which is ok for mocks
        - src/Core/Content/Test/ImportExport/MockRepository.php

        # @todo NEXT-22697 - Remove when re-enabling cms-aware
        - src/Core/System/CustomEntity/Xml/Config/CustomEntityEnrichmentService.php
        - tests/integration/php/Core/System/CustomEntity/Xml/Config/CmsAwareAndAdminUiTest.php

        # PHPStan rule test files
        - tests/unit/php/Core/DevOps/StaticAnalyse/PHPStan/Rules/data/*

    ignoreErrors:
        # The symfony extension checks against the "normal" container, not the test container
        # Therefore some services in the tests are not found and the extension can not infer that all private services are public during test execution
        -
            message: '#Service ".*" is not registered in the container\.#'
            paths:
                - src/**/*Test.php
                - tests/unit/php
                - tests/integration/php
                - src/Core/Framework/Test/TestCaseBase/*.php
        -
            message: '#Service ".*" is private#'
            paths:
                - src/**/*Test.php
                - src/**/*TestCase.php
                - tests/performance/**/*Bench.php
                - tests/integration/**/*Test.php
                - tests/integration/**/*TestCase.php

        # ignore errors caused by static::markTestSkipped
        -
            message: '#Unreachable statement - code above always terminates.#'
            paths:
                - src/**/*Test.php
                - tests/**/*Test.php

        # To fix this error, the \Shopware\Core\Framework\Struct\Collection::createNew method has to be implemented
        # in every implementation of `Collection` and needs to return `new self` instead of `new static`. See https://github.com/phpstan/phpstan/issues/2773
        -
            message: '#Unsafe usage of new static\(\)#'
            path: src/Core/Framework/Struct/Collection.php
        -
            message: '#Access to private property#'
            path: src/Core/Framework/Api/Controller/CacheController.php
        # @final annotation of internal classes
        - '#.*extends @final class Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\EntitySearchResult\.#'
        - '#.*extends @final class Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepository.#'
        - '#Class Shopware\\Tests\\Integration\\Elasticsearch\\Product\\EsAwareCriteria extends @final class Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria\.#'

        # dynamic hydrator performance
        -
            message: '#Access to an undefined property Shopware\\Core\\Framework\\DataAbstractionLayer\\Entity#'
            path: src/*/*Hydrator.php
        -
            message: '#Access to protected property *#'
            path: src/*/*Hydrator.php
        -
            message: '#Method Shopware\\Core\\Framework\\DataAbstractionLayer\\Entity::\_\_.*\(\) has.*#'
            path: src/Core/Framework/DataAbstractionLayer/Entity.php

        # can be removed with feature flag FEATURE_NEXT_12455
        -
            message: '#Method Shopware\\Core\\Checkout\\Cart\\Facade\\.*::getIterator\(\) return type with generic class ArrayIterator does not specify its types: TKey, TValue#'
            path: src/Core/Checkout/Cart/Facade/Traits/ItemsIteratorTrait.php
        # Is in the new super class nullable as the extended class
        -
            message: "#^PHPDoc type string\\|null of property Shopware\\\\Core\\\\Framework\\\\DataAbstractionLayer\\\\Field\\\\ReferenceVersionField\\:\\:\\$storageName is not covariant with PHPDoc type string of overridden property Shopware\\\\Core\\\\Framework\\\\DataAbstractionLayer\\\\Field\\\\FkField\\:\\:\\$storageName\\.$#"
            count: 1
            path: src/Core/Framework/DataAbstractionLayer/Field/ReferenceVersionField.php

        # PhpStan cannot follow the referenced cursor
        -
            message: "#^Variable \\$extensions in empty\\(\\) always exists and is always falsy\\.$#"
            count: 1
            path: src/Core/Framework/DataAbstractionLayer/VersionManager.php

        # Invalid trait usage
        -
            message: "#^Dead catch \\- ReflectionException is never thrown in the try block\\.$#"
            count: 1
            path: src/Core/Checkout/Cart/Error/Error.php

        -
            message: "#^Dead catch \\- ReflectionException is never thrown in the try block\\.$#"
            count: 1
            path: src/Core/Content/ProductExport/Error/Error.php

        - # MockRepo extends final EntityRepository class, with is ok for tests
            message: "#^Class Shopware\\Core\\Content\\Test\\ImportExport\\MockRepository extends @final class Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepository.$#"
            count: 1
            path: src/Core/Content/Test/ImportExport/MockRepository.php

        - # Tests are skipped in setup, leading to phpstan errors, should be re-enabled with NEXT-24549
            message: "#^Property .* is never written, only read.$#"
            paths:
                - src/Core/Migration/Test/Migration1648803451FixInvalidMigrationOfBusinessEventToFlowTest.php
                - src/Core/Migration/Test/Migration1639992771MoveDataFromEventActionToFlowTest.php
                - src/Core/Migration/Test/Migration1632215760MoveDataFromEventActionToFlowTest.php
                - src/Core/Migration/Test/Migration1625583619MoveDataFromEventActionToFlowTest.php

        - # @deprecated tag:v6.5.0 Using autoload === true on associations is deprecated and must be refactored
            message: '#^[a-zA-Z_]+\.[a-zA-Z_]+ association has a configured autoload\=\=\=true, this is forbidden for platform integrations$#'
            paths:
                - src/Core/System/SalesChannel/SalesChannelDefinition.php
                - src/Core/Content/Rule/Aggregate/RuleCondition/RuleConditionDefinition.php
                - src/Core/Content/Product/ProductDefinition.php
                - src/Core/Content/Product/Aggregate/ProductMedia/ProductMediaDefinition.php
                - src/Core/Content/ImportExport/Aggregate/ImportExportLog/ImportExportLogDefinition.php
                - src/Core/Checkout/Shipping/ShippingMethodDefinition.php
                - src/Core/Checkout/Payment/PaymentMethodDefinition.php
                - src/Core/System/NumberRange/NumberRangeDefinition.php

        - # NEXT-25276 - Needs to be fixed with the update ot PHPUnit 10
            message: '#deprecated interface PHPUnit\\Framework\\TestListener#'
            path: src/Core/Framework/Test/TestCaseBase/DatadogListener.php

        # Internal deprecations of Shopware are handled in other places
        - '#deprecated.*class Shopware\\#'

        - # we override setUp visibility a lot
            message: '#Change "setUp\(\)" method visibility to "protected" to respect parent method visibility\.#'
            paths:
                - src/**/*Test.php
                - tests/**/*Test.php
        - # we override tearDown visibility a lot
            message: '#Change "tearDown\(\)" method visibility to "protected" to respect parent method visibility\.#'
            paths:
                - src/**/*Test.php
                - tests/**/*Test.php

        - # tests are allowed to add dummy classes in the same file
            message: '#Multiple class\/interface\/trait is not allowed in single file#'
            paths:
                - src/**/Test/**
                - tests/**
                - src/Core/Framework/Migration/Exception/UnknownMigrationSourceException.php # uses if around class definition

        # It explicitly tests array access on object, so it works from twig scripts
        -
            message: "#Use explicit methods over array access on object$#"
            path: src/Core/Framework/Test/Script/Service/ArrayFacadeTest.php

        # Breaking changes which are not worth it
        - '#Method Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityCollection::filterAndReduceByProperty\(\) has parameter \$value with no type specified\.#'

services:
    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Deprecation\DeprecatedMethodsThrowDeprecationRule
        tags:
            - phpstan.rules.rule
    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Internal\InternalClassRule
        tags:
            - phpstan.rules.rule
    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Internal\InternalMethodRule
        tags:
            - phpstan.rules.rule
    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Tests\CoversAnnotationRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\FinalClassRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Tests\MockingSimpleObjectsNotAllowedRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\ScheduledTaskTooLowIntervalRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\RuleAreasFlagNotAllowedRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoEnvironmentHelperInsideCompilerPassRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoSuperGlobalsInsideCompilerPassRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Type\CollectionHasSpecifyingExtension
        tags:
            - phpstan.typeSpecifier.methodTypeSpecifyingExtension

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\RuleConditionHasRuleConfigRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\PackageAnnotationRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoDALAutoload
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\PHPUnitDataProviderStaticRule
        tags:
            - phpstan.rules.rule

    -
        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoFlowStoreFunctionRule
        tags:
            - phpstan.rules.rule

# Activate again when https://github.com/symplify/phpstan-rules/pull/25 is released
#    -
#        class: Symplify\PHPStanRules\Rules\ForbiddenThisArgumentRule
#        tags: [phpstan.rules.rule]
#        arguments:
#            allowedCallerClasses:
#                - Shopware\Core\Framework\Feature
#                - Shopware\Core\Framework\DataAbstractionLayer\Search\CriteriaArrayConverter
#                - Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition
#                - Shopware\Core\Content\ImportExport\DataAbstractionLayer\Serializer\Field\AbstractFieldSerializer
#                - Shopware\Core\Content\ImportExport\DataAbstractionLayer\Serializer\Entity\AbstractEntitySerializer
#                - Shopware\Core\Framework\Struct\Collection
#                - Shopware\Core\Checkout\Document\DocumentConfigurationFactory
#                - Symfony\Component\Validator\Validator\ValidatorInterface
#                - Twig\Compiler

rules:
    # rules from https://github.com/symplify/phpstan-rules
    - Symplify\PHPStanRules\Rules\Spotter\IfElseToMatchSpotterRule
    - Symplify\PHPStanRules\Rules\Missing\CheckSprintfMatchingTypesRule

    # domain
    - Symplify\PHPStanRules\Rules\CheckAttributteArgumentClassExistsRule
    - Symplify\PHPStanRules\Rules\Enum\RequireUniqueEnumConstantRule
    - Symplify\PHPStanRules\Rules\ForbiddenParamTypeRemovalRule
    - Symplify\PHPStanRules\Rules\PreventParentMethodVisibilityOverrideRule

    # paths
    - Symplify\PHPStanRules\Rules\NoMissingDirPathRule
    - Symplify\PHPStanRules\Rules\NoArrayAccessOnObjectRule

    # dead-code
    - Symplify\PHPStanRules\Rules\NoIssetOnObjectRule

    # explicit naming
    - Symplify\PHPStanRules\Rules\NoParentMethodCallOnNoOverrideProcessRule
    # Activate again when https://github.com/symplify/phpstan-rules/pull/19 is released
    # - Symplify\PHPStanRules\Rules\RequireThisOnParentMethodCallRule
    - Symplify\PHPStanRules\Rules\RequireThisCallOnLocalMethodRule
    - Symplify\PHPStanRules\Rules\ForbiddenMultipleClassLikeInOneFileRule

    - Symplify\PHPStanRules\Rules\Complexity\ForbiddenArrayMethodCallRule
    - Symplify\PHPStanRules\Symfony\Rules\PreventDoubleSetParameterRule