Install Account Bundle

softspring/account-bundle adds an ownership layer above users. In most applications, the account becomes the business owner of subscriptions, projects, invoices, or other data, and users operate those resources through memberships or ownership.

This bundle expects softspring/user-bundle to be installed first. Enable softspring/twig-extra-bundle as well: the account request listener requires its extensible app variable and exposes the current account as app.account.

Install The Package

composer require softspring/account-bundle:6.1.*@dev

If your application does not use Symfony Flex, enable the bundle manually:

<?php

return [
    // ...
    Softspring\AccountBundle\SfsAccountBundle::class => ['all' => true],
];

Add Base Configuration

Start with a minimal configuration and then enable only the parts you really need:

YAML

# config/packages/sfs_account.yaml
sfs_account:
    class: App\Entity\Account
    membership_class: App\Entity\AccountMembership
    admin: true
    twig_app_var_name: account
    route_param_name: _account
    find_field_name: id
    filter:
        enabled: true

PHP

<?php

// config/packages/sfs_account.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container): void {
    $container->extension('sfs_account', [
        'class' => \App\Entity\Account::class,
        'membership_class' => \App\Entity\AccountMembership::class,
        'admin' => true,
        'twig_app_var_name' => 'account',
        'route_param_name' => '_account',
        'find_field_name' => 'id',
        'filter' => ['enabled' => true],
    ]);
};

The most important options are:

  • class
    • your concrete account entity used for AccountInterface
  • membership_class
    • your concrete membership relation used for AccountMembershipInterface
  • admin
    • loads the built-in admin controllers and forms
  • filter.enabled
    • enables automatic account filtering and automatic account assignment on prePersist

The context resolver, request listener, value resolver, and write listener use route_param_name. The SQL filter uses an internal _account parameter independently of the URL name. Keep the default for consistency unless your application needs another route attribute.

Import Only The Routes You Need

The bundle ships route files by feature. Import only the ones that match your application:

YAML

# config/routes/sfs_account.yaml
_sfs_account_register:
    resource: '@SfsAccountBundle/config/routing/register.yaml'
    prefix: /register/account

_sfs_account_settings:
    resource: '@SfsAccountBundle/config/routing/settings.yaml'
    prefix: /account/{_account}/settings

_sfs_account_settings_users:
    resource: '@SfsAccountBundle/config/routing/settings_users.yaml'
    prefix: /account/{_account}/settings/users

_sfs_account_user_accounts:
    resource: '@SfsAccountBundle/config/routing/user_accounts.yaml'
    prefix: /user/accounts

_sfs_account_admin_accounts:
    resource: '@SfsAccountBundle/config/routing/admin_accounts.yaml'
    prefix: /admin/accounts

PHP

<?php

// config/routes/sfs_account.php
namespace Symfony\Component\Routing\Loader\Configurator;

return static function (RoutingConfigurator $routes): void {
    $routes->import('@SfsAccountBundle/config/routing/register.yaml')->prefix('/register/account');

    $routes->import('@SfsAccountBundle/config/routing/settings.yaml')
        ->prefix('/account/{_account}/settings');

    $routes->import('@SfsAccountBundle/config/routing/settings_users.yaml')
        ->prefix('/account/{_account}/settings/users');

    $routes->import('@SfsAccountBundle/config/routing/user_accounts.yaml')->prefix('/user/accounts');

    $routes->import('@SfsAccountBundle/config/routing/admin_accounts.yaml')->prefix('/admin/accounts');
};

Practical rule:

  • import register.yaml when users can create their own account
  • import settings.yaml when users can rename or manage the current account
  • import settings_users.yaml when you want a bundled starting page for account members
  • import user_accounts.yaml when users can belong to several accounts
  • import admin_accounts.yaml when backoffice staff manage accounts centrally

Typical First Working Setup

For a new SaaS-style application, a practical first milestone is:

  1. install user-bundle
  2. create Account and AccountMembership
  3. enable filter.enabled
  4. import register.yaml and settings.yaml
  5. build one real account area under /account/{_account}/...

That gives you enough to test the real model early: account registration, current account resolution, and account-scoped data.

What The Bundle Adds At Runtime

After installation, the bundle can provide:

  • target entity resolution for account and relation interfaces
  • request-time resolution of the current account from /{_account}
  • app.account in Twig
  • built-in registration, settings, user, and admin pages
  • Doctrine account filtering for entities that opt in
  • automatic account assignment on account-aware write requests

The bundle does not replace your project model. You still own the real account entity, relation entity, and business entities.

Table of contents

  1. Install The Package
  2. Add Base Configuration
  3. Import Only The Routes You Need
  4. Typical First Working Setup
  5. What The Bundle Adds At Runtime
  6. Related Guides