Configuration

StructArmed configuration is PHP code. Define layers, apply presets, skip known exceptions, and tune preset rules.

Contents

1. Custom Layers And Preset Overrides
2. Skipping Paths And Rules
3. Replacing Preset Rules
4. Custom Extensions
5. Preset Constructor Parameters

Custom Layers And Preset Overrides

<?php

use Boundwize\StructArmed\Architecture;
use Boundwize\StructArmed\Preset\Preset;
use Boundwize\StructArmed\Preset\Presets\DddPreset;
use Boundwize\StructArmed\Rule\Rules\Class_\MustBeFinalRule;

return Architecture::define()
    ->layer('Domain', 'src/Domain/')
    ->layer('Application', 'src/Application/')
    ->layer('Infrastructure', 'src/Infrastructure/')
    ->skip([
        'tests/Fixtures/',
        'var/cache/*',
        DddPreset::DOMAIN_NO_DATETIME,
        DddPreset::ENTITY_MUST_BE_FINAL => ['src/Legacy/'],
    ])
    ->withPreset(Preset::DDD())

    // Replace a rule with a different configuration.
    ->replaceRule(
        DddPreset::ENTITY_MUST_BE_FINAL,
        new MustBeFinalRule(layer: 'Domain', classNamePattern: '/Entity$|Aggregate$/')
    );

Skipping Paths And Rules

Inside skip(), string entries skip files or directories unless they match a registered rule key.

Keyed entries skip paths for a specific rule:

->skip([
    DddPreset::ENTITY_MUST_BE_FINAL => ['src/Legacy/'],
])

Rule key constants skip that rule entirely:

->skip([
    DddPreset::DOMAIN_NO_DATETIME,
])

Use skipPath() / skipPaths() and skipRule() / skipRules() when you prefer explicit method names.

Replacing Preset Rules

Use replaceRule() to swap a preset rule’s configuration:

->replaceRule(
    DddPreset::ENTITY_MUST_BE_FINAL,
    new MustBeFinalRule(layer: 'Domain', classNamePattern: '/Entity$|Aggregate$/')
)

replaceRule() throws RuleNotFoundException if the target key does not exist, so typos are caught immediately.

Custom Extensions

Use Custom Rules And Presets when you want to add project-specific rules or package reusable rule sets.

Preset Constructor Parameters

->withPreset(Preset::DDD(
    maxComplexity:        3,     // default: 5
    maxMethodLength:      15,    // default: 20
    enforceFinalEntities: false, // default: true
))

->withPreset(Preset::MVC(
    controllerMaxComplexity:   3,  // default: 5
    controllerMaxDependencies: 4,  // default: 5
    viewMaxComplexity:         2,  // default: 3
))

->withPreset(Preset::PSR1(
    sourcePaths: ['src/', 'tests/'], // default: read composer.json PSR-4 paths
))

->withPreset(Preset::PSR12(
    sourcePaths: ['src/', 'tests/'], // default: read composer.json PSR-4 paths
))

->withPreset(Preset::PSR15(
    sourcePaths: ['src/', 'tests/'], // default: read composer.json PSR-4 paths
))

->withPreset(Preset::PSR4(
    sourcePaths: ['src/', 'tests/'], // default: read composer.json PSR-4 paths
))