Presets

StructArmed ships with presets for common PHP standards and architecture styles.

Contents

1. Available Presets
2. Initialize Presets
3. Combining Presets
4. Rule Key Constants

Available Presets

Preset	Rules
Preset::PSR4()	Verifies configured source paths exist in composer.json autoload or autoload-dev PSR-4 mappings
Preset::PSR1()	Basic Coding Standard checks: PHP tags, valid UTF-8, UTF-8 without BOM, symbols vs side effects, PSR-4 class placement, StudlyCaps class names, upper-case class constants, camelCase methods
Preset::PSR12()	Extends PSR-1: PHP keyword constants (true, false, and null) must be lowercase, and all methods, constants, and properties must declare explicit visibility
Preset::PER()	PER Coding Style: extends PSR-12 (and, through it, PSR-1) and adds PascalCase enum case names, no protected enum methods or constants, and no empty () on anonymous classes that pass no constructor argument (new class {}, not new class () {}); the anonymous-class and protected rules support --fix
Preset::PSR15()	*Middleware classes must implement PSR-15 MiddlewareInterface; *Handler classes must implement PSR-15 RequestHandlerInterface; StructArmed also enforces matching Middleware/Handler suffixes for implementations of those interfaces
Preset::DDD()	Layer isolation, entity/VO/repository/event/service conventions, including keeping Doctrine ORM repository inheritance out of the Domain layer
Preset::MVC()	Layer isolation, thin controllers, model/view/service rules, return types for helper functions
Preset::YAGNI()	Speculative-abstraction cleanup: interfaces must be implemented by a class or extended by another interface, abstract classes must be extended, traits must be used, and extended classes that are never instantiated must be abstract — a dependency reference (type hint, instanceof, ::class, static call, a class-name string, …) also counts as usage within the scanned paths, while only instantiation (new X, new self/static/parent, or a constant class expression such as new (X::class)) keeps an extended class concrete. All rules support --fix, removing the unused declaration or adding the abstract modifier
Preset::CODEQUALITY()	General readability conventions independent of any architecture style: closures and arrow functions that do not read $this must be declared static, and plain decimal numeric literals of 1_000_000 or more must group their digits with _ separators (1000500 becomes 1_000_500). Both rules support --fix. Tune the literal threshold with replaceRule(CodeQualityPreset::LARGE_NUMERIC_LITERALS_MUST_USE_SEPARATOR, new LargeNumericLiteralMustUseSeparatorRule(minimum: 1_000))

Initialize Presets

vendor/bin/structarmed init --preset=psr4
vendor/bin/structarmed init --preset=psr1
vendor/bin/structarmed init --preset=psr12
vendor/bin/structarmed init --preset=per
vendor/bin/structarmed init --preset=psr15
vendor/bin/structarmed init --preset=mvc
vendor/bin/structarmed init --preset=ddd
vendor/bin/structarmed init --preset=yagni
vendor/bin/structarmed init --preset=codequality
vendor/bin/structarmed init --preset=all

Combining Presets

return Architecture::define()
    ->withPresets(
        Preset::PSR4(),
        Preset::PSR1(),
        Preset::PSR12(),
        Preset::PER(),
        Preset::PSR15(),
        Preset::MVC(),
        Preset::DDD(),
        Preset::YAGNI(),
        Preset::CODEQUALITY(),
    );

Rule Key Constants

Every preset rule has a public constant. Use constants instead of raw strings so IDEs and static analysis can catch mistakes.

// Good: caught by IDE and static analysis.
DddPreset::ENTITY_MUST_BE_FINAL

// Bad: typo silently does nothing.
'ddd.entity.must_be_fnal'