dreikern/phpstan-oxid

PHPStan extension for OXID eShop

0.2.0 2024-11-16 16:21 UTC

Requires

• php: ^8.0
• phpstan/phpstan: ^2.0
• symfony/yaml: >=3.4

Requires (Dev)

• nikic/php-parser: ^4.13.0 || ^5.0
• oxid-esales/oxideshop-ce: ^v6.8.0 || ^v7.0.0@rc
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^9.5

MIT

README

• PHPStan
• OXID eShop

This extension provides following features:

• OXID eShop uses class chaining in order to inject modules into their system. This class chain is built at runtime so PHPStan, as a static code analyzer, isn't able to detect that. This extension reads your shop configuration (e.g. var/configuration/shops/1.yaml) and builds this class chain when PHPStan is analyzing your code. Only activated modules are considered. This allows PHPStan to do its magic.
• When using oxNew() or Registry::get() this extension dynamically changes the return type when PHPStan is analyzing your code, so it is aware of any changes your code adds to OXID eShop classes.
• Stubs some OXID eShops classes to fix incorrect phpdoc comments in OXID eShop. Feel free to contribute more stubs when you encounter such mistakes. PHPStan Documentation
• Provide rules to detect usage of legacy class names (e.g. oxdiscount instead of \OxidEsales\Eshop\Application\Model\Discount) or classes without unified namespace (e.g. \OxidEsales\EshopCommunity\Application\Model\Voucher instead of \OxidEsales\Eshop\Application\Model\Voucher).

Installation

To use this extension, require it in Composer:

composer require --dev dreikern/phpstan-oxid

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/dreikern/phpstan-oxid/extension.neon

Configuration

If the path to your shops module configuration differs from var/configuration/shops/1.yaml , you can override the path in your phpstan.neon:

parameters:
    oxid:
        shopConfigurationPath: var/configuration/shops/1.yaml

If you need to analyze different subshops without changing your phpstan.neon you are able to set the path via environment variable:

PHPSTAN_OXID_CONFIG_PATH=path/to/config/1.yaml ./vendor/bin/phpstan analyze path/to/oxid/module

Rules

OxNewCalledWithEditionNamespaceRule

oxNew() call with edition namespace for class %s. Use %s instead.

• class: dreikern\PhpStanOxid\Rule\OxNewCalledWithEditionNamespaceRule

oxNew(\OxidEsales\EshopCommunity\Application\Model\Voucher::class);

❌

oxNew(\OxidEsales\Eshop\Application\Model\Voucher::class);

✅

OxNewCalledWithLegacyClassNameRule

oxNew() call with legacy className %s. Use %s instead.

• class: dreikern\PhpStanOxid\Rule\OxNewCalledWithLegacyClassNameRule

oxNew('oxdiscount');

❌

oxNew(\OxidEsales\Eshop\Application\Model\Discount::class);

✅

RegistryGetCalledWithEditionNamespaceRule

Registry::get() call with edition namespace for class %s. Use %s instead.

• class: dreikern\PhpStanOxid\Rule\RegistryGetCalledWithEditionNamespaceRule

Registry::get(\OxidEsales\EshopCommunity\Application\Model\Voucher::class);

❌

Registry::get(\OxidEsales\Eshop\Application\Model\Discount::class);

✅

RegistryGetCalledWithLegacyClassNameRule

Registry::get() call with legacy className %s. Use %s instead.

• class: dreikern\PhpStanOxid\Rule\RegistryGetCalledWithLegacyClassNameRule

Registry::get('oxdiscount');

❌

Registry::get(\OxidEsales\Eshop\Application\Model\Voucher::class);

✅

Credits

This PHPStan extensions is heavily inspired by phpstan-doctrine