PHPStan Configuration & Rules

phpstan.neon Configuration File

parameters:
    level: 6
    paths:
        - app/code/Vendor/Module/Api/
        - app/code/Vendor/Module/Model/
        - app/code/Vendor/Module/Service/

    # Exclude test files and generated code
    excludePaths:
        - */Test/*
        - */_files/*
        - */generated/*

    # Ignore specific errors
    ignoreErrors:
        - '#Call to an undefined method Magento\\Framework\\DataObject::.*#'
        - '#Property .* is never assigned#'
        - '#has invalid typehints#'

    # Treat certain errors as specific level
    reportUnmatchedIgnoredErrors: false
    reportAlwaysUsedPhpDocTypesAsConstant: false

    # Check missing typehints on method parameters
    checkMissingIterableValueType: false
    checkGenericClassInNonGenericObjectType: false

    # Tuning
    polluteScopeWithAlwaysIterable: false
    rememberPossiblyAlwaysTrueConditionAndCheckType: true

Running PHPStan

# Basic analyse
vendor/bin/phpstan analyse

# With specific level override
vendor/bin/phpstan analyse src/ --level=8

# Generate baseline (for existing code)
vendor/bin/phpstan analyse --generate-baseline

# analyse with maximum memory
vendor/bin/phpstan analyse --memory-limit=2G

# Clear cache
vendor/bin/phpstan clear-cache

Magento PHPStan Extension

# phpstan.neon
includes:
    - vendor/magento/magento2-phpstan/extension.neon

parameters:
    level: 6
    paths:
        - app/code/Vendor/

This adds type stubs for:

• Dynamic methods on DataObject
• Magic __call methods
• Magento's factory pattern
• Scope config methods

Custom PHPStan Extension

namespace Vendor\Module\PHPStan\Rules;

use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;

class NoDirectObjectManagerUsage implements Rule
{
    public function getNodeType(): string
    {
        return Node\Expr\MethodCall::class;
    }

    public function processNode(Node $node, Scope $scope): array
    {
        if ($this->isGetObjectCall($node, $scope)) {
            return [
                'Direct ObjectManager usage is not allowed. Use dependency injection.',
            ];
        }
        return [];
    }

    private function isGetObjectCall(Node $expr, Scope $scope): bool
    {
        if (!$expr->name instanceof Node\Identifier) {
            return false;
        }

        if ($expr->name->name !== 'get') {
            return false;
        }

        $type = $scope->getType($expr->var);
        return $type instanceof \PHPStan\Type\ObjectType
            && $type->getClassName() === \Magento\Framework\ObjectManager\ObjectManager::class;
    }
}

Register in extension:

# phpstan-extension.neon
services:
    -
        class: Vendor\Module\PHPStan\Rules\NoDirectObjectManagerUsage
        tags:
            - phpstan.rules.rule

PHPStan for Magento Best Practices

# Recommended Magento configuration
parameters:
    level: 6

    # Magento ignores
    ignoreErrors:
        # DataObject magic methods
        - '#Property .* does not exist on \*DataObject#'
        # Factory create() return types
        - '#returned type \*Factory::create\(\) is not \*Interface#'
        # Scope config dynamic methods
        - '#Call to undefined method .*getValue\(#'

    # Custom stubs for Magento
    stubs:
        - etc/phpstan/stubs/*.stub

GitHub Actions Integration

# .github/workflows/phpstan.yml
name: PHPStan

on: [push, pull_request]

jobs:
  phpstan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.1'
          extensions: mbstring, intl
          coverage: none

      - name: Install Dependencies
        run: composer install --prefer-dist --no-progress

      - name: Run PHPStan
        run: vendor/bin/phpstan analyse --error-format=github --no-progress

      - name: Run PHPStan (strict)
        run: vendor/bin/phpstan analyse --level=8 --error-format=github
        continue-on-error: true  # Allow failure for strict level

Pre-commit Hook

#!/bin/bash
# .git/hooks/pre-commit

echo "Running PHPStan..."
vendor/bin/phpstan analyse app/code/Vendor/Module/ --no-progress --error-format=raw

if [ $? -ne 0 ]; then
    echo "PHPStan failed. Fix errors before committing."
    exit 1
fi

echo "PHPStan passed!"

PHPStan Baseline

# Generate baseline for existing code
vendor/bin/phpstan analyse --generate-baseline phpstan-baseline.neon

# phpstan.neon
includes:
    - phpstan-baseline.neon  # Existing errors are ignored

parameters:
    level: 6

The baseline lets you adopt PHPStan gradually — fix new errors but don't fix existing ones yet.