EasyAdmin Pro

Requirements

Your application must meet the EasyAdmin requirements for your installed version, as well as these requirements for EasyAdmin Pro:

• PHP 8.1 or higher, with the intl extension enabled;
• Symfony 5.4, 6.4, 7.x or 8.x;
• EasyAdmin 4.27.6 or later in the 4.x series, or EasyAdmin 5.x;
• Doctrine ORM 2.14 or later in the 2.x series, or 3.6.8 or later in the 3.x series;
• Doctrine DBAL 3.7 or later in the 3.x series, or 4.x;
• Doctrine Bundle 2.5 or later in the 2.x series, or 3.x.

Installing the Bundle

Purchase a license at easycorp.io and follow the instructions provided with it to configure the private Composer repository.

Once you have access to the package, install it with Composer:

1

$ composer require easycorp/easyadmin-pro-bundle

If your application uses Symfony Flex, the bundle is enabled automatically. Otherwise, register it in the config/bundles.php file:

1
2
3
4
5

// config/bundles.php
return [
    // ...
    EasyCorp\Bundle\EasyAdminProBundle\EasyAdminProBundle::class => ['all' => true],
];

Installing the Assets

The bundle provides its own CSS and JavaScript assets, which must be published in your application's public/ directory:

1

$ php bin/console assets:install

The assets don't need Webpack Encore, AssetMapper or a separate frontend build. Run assets:install again after updating the bundle.

Enabling the Features

Audit Log, Content Lock and Messenger Inspector are disabled by default. Enable the ones you need in config/packages/easyadmin_pro.yaml. For example, to protect edit forms with content locking:

1
2
3
4

# config/packages/easyadmin_pro.yaml
easyadmin_pro:
    content_lock:
        enabled: true

Each feature's article walks you through its setup:

• Audit Log also needs a signing key by default.
• Content Lock works with your existing CRUD pages.
• Messenger Inspector requires Symfony Messenger and a controller to display the inspector.
• Markdown Editor Field needs no bundle configuration; add the field to your CRUD controller.

Database Configuration

The features that store data (Audit Log, Content Lock and Messenger Inspector) create their own database tables. By default, they use the default Doctrine DBAL connection. Use the global dbal_connection option to change the connection used by all features, or override it per feature:

1
2
3
4
5
6
7
8

# config/packages/easyadmin_pro.yaml
easyadmin_pro:
    # the DBAL connection used by all features (default: 'default')
    dbal_connection: 'default'

    audit_log:
        # this feature stores its data in a different connection
        dbal_connection: 'audit'

After enabling a feature, generate a Doctrine migration to create its tables, review the generated SQL, and apply it:

1
2

$ php bin/console make:migration
$ php bin/console doctrine:migrations:migrate

These commands require MakerBundle and DoctrineMigrationsBundle; EasyAdmin Pro doesn't install them for you. The enabled features' tables are included in Doctrine's schema automatically.

Use table_name under each feature to change its main table name. Audit Log also provides integrity.head_table_name and integrity.checkpoint_table_name. The optional Messenger events table uses the main table name with an _events suffix.

Overriding Templates

To customize any of the Twig templates provided by the bundle, create a template with the same path inside the templates/bundles/EasyAdminProBundle/ directory of your application. For example, to customize the page displayed when an entity is locked, create this template:

1
2
3
4
5
6

your-project/
├── templates/
│   └── bundles/
│       └── EasyAdminProBundle/
│           └── content_lock/
│               └── _locked_entity.html.twig