Configuration reference

Everything under the phil_feature_flags key, as PhilFeatureFlagsBundle::configure() declares it, and what each option wires. Run bin/console config:dump-reference phil_feature_flags for the tree as Symfony prints it.

Annotated example

# config/packages/phil_feature_flags.yaml
phil_feature_flags:
    # Service id of the resolver of the evaluation context of a request.
    # Default: the service id `Phil\FeatureFlagsBundle\Application\Flag\EvaluationContextResolver`.
    # `phil_feature_flags.context_resolver.anonymous` gives every request an empty context.
    context_resolver: App\Flags\RequestContextResolver

    # The database store. Off by default; `doctrine: true` or any map turns it on.
    doctrine:
        connection: default            # DBAL connection name; default "default"

    # Provider service ids, in order of precedence. Default: the configuration provider, then the
    # database store when `doctrine` is enabled.
    providers:
        - phil_feature_flags.provider.configuration
        - phil_feature_flags.provider.doctrine

    # Service id of the store of active states. Default: the database store when enabled, otherwise none.
    state_store: phil_feature_flags.state_store.doctrine

    # Service id of the store the admin creates and edits flags in. Default: the database store when enabled.
    definition_store: phil_feature_flags.provider.doctrine

    # Service id of the recorder of A/B exposures. Default: none.
    exposure_recorder: App\Flags\ExposureCounter

    # The audited toggle and edit. Off by default; any map turns it on.
    toggle:
        authorizer: App\Flags\PermissionAuthorizer   # default: the ToggleAuthorizer interface id
        auditor: App\Flags\AuditTrailAuditor         # default: the ToggleAuditor interface id

    # The admin screens. Off by default; any map turns them on. They need `toggle`.
    admin:
        actor_provider: App\Flags\OperatorProvider   # default: the ActorProvider interface id
        layout: 'admin/layout.html.twig'             # default: '@PhilFeatureFlags/admin/layout.html.twig'

    # Service id of the PSR-20 clock. Default: "clock".
    clock: clock

    # The flags of the configuration provider, by name.
    flags:
        new-checkout:
            active: true
            rules:
                - { attribute: tenant, members: [tenant-a, tenant-b] }
                - { attribute: tenant, percentage: 20 }
            description: The one-page checkout.
            owner: checkout-team
            kind: release
            expires_on: '2027-03-31'
        checkout-layout:
            active: true
            experiment:
                attribute: tenant
                variants: { one-column: 50, two-columns: 50 }
            kind: experiment
        search.v2: false               # short for { active: false }
        maintenance-banner: true       # short for { active: true }: on for everyone

Keys

context_resolver

The default is the interface name, so the application either registers a service under that id (an autowiring alias does) or names its own. phil_feature_flags.context_resolver.anonymous (AnonymousContextResolver) is always registered: every context is empty, so a flag with rules or an experiment is off for everyone and only flags without rules are on. See flags-and-evaluation.md.

doctrine

When enabled, the bundle registers:

• phil_feature_flags.provider.doctrine — DoctrineFlagDefinitions, tagged kernel.reset: a provider and the writable definition store;
• phil_feature_flags.state_store.doctrine — DoctrineFlagStore, tagged kernel.reset: the writable store of active states;
• FlagSchemaListener, tagged doctrine.event_listener on postGenerateSchema for that connection.

It also changes the defaults of providers, state_store and definition_store. See database-store.md.

providers

The first provider that knows a flag gives its whole definition; an empty list means the default. The catalog keys the providers by their service id, which is what the listing and the admin show as Source. Each service implements FlagProvider; implement EnumerableFlagProvider to appear in the listing. Naming phil_feature_flags.provider.doctrine without enabling doctrine fails the container compilation with a missing service. Leave out phil_feature_flags.provider.configuration and the flags of the configuration are never read (the provider is still registered).

state_store

Without toggle, any FlagStateSource will do. With toggle, it must be a WritableFlagStore.

definition_store

The admin shows the edit link only for flags whose catalog source is this exact service id, so the definition store should also be one of the providers.

exposure_recorder

See experiments.md.

toggle

Registers FlagToggler (authorizer, state store, auditor, clock, FlagCatalog) and, when definition_store is set, FlagEditor (authorizer, definition store, state store, auditor, clock, FlagCatalog). See toggles-and-edits.md.

admin

The controller also takes the twig and router services. The routes are not loaded automatically: import @PhilFeatureFlagsBundle/config/routes/admin.php (installation.md, admin.md).

clock

flags

A map of flag name to definition, read by ConfiguredFlagProvider (service phil_feature_flags.provider.configuration). Keys are not normalized, so dashes stay dashes.

Variant names follow the alphabet of flag names, at most 50 bytes. A flag named circuit-open.<key> takes no rule and no experiment. See targeting.md, experiments.md and metadata-and-expiry.md.

For each circuit declared to phil/circuit-breaker-bundle, the configuration provider also declares circuit-open.<key>, inactive, without rules, of kind ops, with the description Forces the circuit "<key>" open., unless flags declares that name itself. See circuit-breakers.md.

Services registered in every configuration

Conditional services are listed with their option above; the complete inventory is in extension-points.md. All services are private except FlagAdminController; the class-named ones can be autowired by type.

Build-time validation

Every flag is parsed while the container is built, so a malformed entry fails cache:clear rather than the first request. Errors are InvalidConfigurationExceptions:

The Symfony configuration tree adds its own errors before these (a missing attribute in a rule, a non-integer percentage, an empty string where cannotBeEmpty() applies). A service id that does not exist is reported by the container compiler, not by the bundle.