ebln/phpstan-factory-rule

PHPStan rule to enforce instanciation by factories

0.0.1 2021-11-12 19:38 UTC

Requires

• php: 7.3 - 8.2
• ebln/phpstan-factory-mark: ^1.0
• phpstan/phpstan: ^0.12 || ^1

Requires (Dev)

• ergebnis/composer-normalize: ^2.15
• phpmd/phpmd: ^2.10
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest
• vimeo/psalm: ^4.12

MIT

• ebln

README

Enforce that your classes get only instantiated by the factories you define!

Usage

Install this package and the marking package alongside with PHPStan.

Implement \Ebln\PHPStan\EnforceFactory\ForceFactoryInterface with the DTO you want to protect.

<?php
// […]
use Ebln\PHPStan\EnforceFactory\ForceFactoryInterface;

class OnlyViaFactory implements ForceFactoryInterface
{
    // […]
    public static function getFactories(): array
    {   // Return a list of classes that are allowed to
        //   create new OnlyViaFactory instances…
        return [TheOnlyTrueFactory::class];
    }
}

Now rely on PHPStan in CI pipelines, git hooks or IDE integrations.

If somebody introduces a rogue factory:

<?php
// […]

class FailingFactory
{
    public function create(): OnlyViaFactory
    {   
        return new OnlyViaFactory();
    }
}

…that is supposed to fail, when you run PHPStan.

Installation

Require this extention and the package containing the interface via Composer:

composer require ebln/phpstan-factory-mark && composer require --dev ebln/phpstan-factory-rule

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

Manual installation

If you don't want to use phpstan/extension-installer, just specify the rule in your project's PHPStan config:

rules:
    - \Ebln\PHPStan\EnforceFactory\ForceFactoryRule