linderp/sulu-base-bundle

Helper classes and functions for sulu

0.1.4 2026-02-11 13:04 UTC

Requires

• php: ^8.2
• jackalope/jackalope-doctrine-dbal: ^2.0
• sulu/sulu: ^2.6
• symfony/config: ^6.2 | ^7.0
• symfony/dependency-injection: ^6.2 | ^7.0
• symfony/framework-bundle: ^6.2 | ^7.0
• symfony/http-foundation: ^6.2 | ^7.0
• symfony/http-kernel: ^6.2 | ^7.0
• symfony/intl: ^6.2 | ^7.0
• symfony/security-core: ^6.3 | ^7.0
• symfony/translation: ^6.2 | ^7.0

MIT

• Pascal Linder

README

Shared Sulu CMS utilities for admin CRUD scaffolding, locale-aware repositories/controllers, and custom admin field types. Use this bundle from your app code to avoid reimplementing standard Sulu admin patterns.

What This Bundle Provides

• Admin CRUD base: Admin/AdminCrud.php plus config value objects for list/form/navigation setup.
• Enable toggle: Admin/AdminEnableToggle.php + Controller/Admin/EnableSwitch.php for standard on/off actions.
• Locale-aware stack: Entity/LocaleTrait.php, Repository/LocaleRepositoryUtil.php, and Controller/Admin/LocaleController.php.
• List builder helper: Common/DoctrineListRepresentationFactory.php for paginated list responses.
• Content types: Content/Types/* registered in Resources/config/services.yaml.
• Admin React fields: Resources/js/src/components/content/types/* registered in Resources/js/src/app.js.

Quick Start: Add a New Admin CRUD

1. Admin class (extend AdminCrud):
   • Implement define() using AdminCrudConfig + AdminCrudNavigationConfig + AdminCrudListConfig + AdminCrudFormConfig.
   • Implement AdminEnableToggle if the entity has an enabled flag.
2. Controller (extend BaseController or LocaleController):
   • Implement getDataForEntity(), mapDataToEntity(), load(), create(), save(), remove().
   • Use EnableSwitch trait if you added the enable toggle.
3. Repository:
   • Extend BaseRepositoryUtil for plain entities or LocaleRepositoryUtil for localized entities.
   • For LocaleRepositoryUtil, implement append() and appendSortByJoins() for list/smart content.

Example: Minimal Admin Definition

final class EventAdmin extends AdminCrud
{
    public static function define(): AdminCrudConfig
    {
        return new AdminCrudConfig(
            'events',
            new AdminCrudNavigationConfig('app.events', 10, 'su-calendar'),
            new AdminCrudListConfig('app.events', 'events', 'app.events_list'),
            new AdminCrudFormConfig('title', 'app.events_add', 'app.events_edit', 'event_form')
        );
    }
}