EasyAdmin

https://symfony.com/bundles/EasyAdminBundle
Admin
EasyAdmin creates beautiful administration backends for Symfony applications, offering a free, fast,...
Tokens:76,343
Snippets:949
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Flysystem Bundle

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Install the Flysystem bundle using Composer. This is the first step to enable remote storage integration.

```bash
$ composer require league/flysystem-bundle
```

--------------------------------

### Install Symfony ExpressionLanguage Component

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Install the ExpressionLanguage component using Composer.

```bash
$ composer require symfony\/expression-language
```

--------------------------------

### Example Translation File

Source: https://symfony.com/bundles/EasyAdminBundle/current/dashboards.html

Example of a translation file using the custom ID structure for entities and fields.

```yaml
# translations/messages.en.yaml
admin:
    entities:
        blogpost:
            singular: 'Blog Post'
            plural: 'Blog Posts'
            fields:
                title: 'Post Title'
```

--------------------------------

### PHP Action Extension Example

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

This example demonstrates how to create a reusable action extension in PHP for EasyAdmin. It shows how to conditionally support the extension and how to add a 'duplicate' action to the detail page.

```php
// <your-package>/src/DuplicateActionExtension.php
use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Action\ActionsExtensionInterface;

final class DuplicateActionExtension implements ActionsExtensionInterface
{
    // return true in this method to enable the extension for
    // the current backend request
    public function supports(AdminContext $context): bool
    {
        // enable the extension only on some pages
        return $context->getCrud()->getCurrentPage() === Crud::PAGE_DETAIL;

        // enable it on all except some entities
        $entityFqcn = $context->getCrud()->getEntityFqcn();
        return null !== $entityFqcn && !\in_array($entityFqcn, ['...'], true);

        // or use any other admin context data to make the decision
    }

    public function extend(Actions $actions, AdminContext $context): void
    {
        $duplicate = Action::new('duplicate', 'Duplicate', 'fa fa-clone')
            ->linkToCrudAction('duplicate')
            ->asSuccessAction();

        $actions->add(Crud::PAGE_DETAIL, $duplicate);

        // you can add single actions, groups of actions, etc.
        // you can also remove or update existing actions
    }
}
```

--------------------------------

### Install Bundle Assets

Source: https://symfony.com/bundles/EasyAdminBundle/current/design.html

Run this command to manually install bundle assets if they are not copied or symlinked correctly. The --symlink option can be omitted if your system does not support symbolic links.

```bash
# remove the --symlink option if your system doesn't support symbolic links
$ php bin/console assets:install --symlink
```

--------------------------------

### Install EasyAdmin Bundle

Source: https://symfony.com/bundles/EasyAdminBundle/current/index.html

Run this command to install the EasyAdmin Bundle using Composer. This is the primary step for integrating EasyAdmin into your Symfony application.

```bash
$ composer require easycorp/easyadmin-bundle
```

--------------------------------

### Install Flysystem Adapter (e.g., AWS S3)

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Install the specific Flysystem adapter for your chosen storage service, such as the AWS S3 v3 adapter. This allows Flysystem to communicate with the remote service.

```bash
$ composer require league/flysystem-aws-s3-v3
```

--------------------------------

### Composer Install Money PHP Library

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Command to install the Money PHP library.

```bash
$ composer require moneyphp/money
```

--------------------------------

### TextEditorField Example

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TextEditorField.html

This is a basic example of how to use the TextEditorField.

```php
yield TextEditorField::new('...')->setNumOfRows(30);
```

--------------------------------

### Association Field Example

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/AssociationField.html

This is a basic example of how to use the AssociationField.

```php
yield AssociationField::new('...');
```

--------------------------------

### Example Usage of setFlysystemStorage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Demonstrates setting the Flysystem storage service ID for a FileField. The provided ID must match a storage defined in your Flysystem configuration.

```php
yield FileField::new('...')->setFlysystemStorage('default.storage');
```

--------------------------------

### Basic Usage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/PercentField.html

This is a basic example of how the PercentField is rendered in a form.

```php
yield PercentField::new('...');
```

--------------------------------

### Render Expanded

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/CollectionField.html

Example of how to render all items in the collection expanded on page load.

```php
yield CollectionField::new('...')->renderExpanded();
```

--------------------------------

### Custom Row Block Example

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Example of overriding the closing block for a custom form row template, demonstrating how to integrate custom logic or HTML.

```twig
{% block _MyEntity_ea_form_row_close_main_row %} {# ... #} {{ block('ea_form_row_close_row') }} {# ... #} {% endblock _MyEntity_ea_form_row_close_main_row %}
```

--------------------------------

### Configure Flysystem Storage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Configure the Flysystem storage in your application's `config/packages/flysystem.yaml` file. This example shows configuration for an AWS S3 bucket.

```yaml
# config/packages/flysystem.yaml
flysystem:
    storages:
        default.storage:
            aws:
                client: 'Aws\S3\S3Client'
                bucket: 'my-bucket'
```

--------------------------------

### Render as Text

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TimeField.html

Example of rendering the time as a single text input field.

```php
yield TimeField::new('...')->renderAsText();
```

--------------------------------

### Customizing Column Template with propertySuffix

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

This example demonstrates how to customize the template used for a form column by providing a `propertySuffix` argument to `addColumn()`. This allows overriding the default `ea_form_column` type.

```php
FormField::addColumn('col-lg-8 col-xl-6', propertySuffix: 'main');
```

--------------------------------

### Restrict Access to Fields

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Example of using `setPermission()` to restrict visibility of fields.

```php
public function getFields(string $action): iterable
{
    return [
        IdField::new('id'),
        TextField::new('price'),
        IntegerField::new('stock'),
        // users must have this permission/role to see this field
        IntegerField::new('sales')->setPermission('ROLE_ADMIN'),
        FloatField::new('commission')->setPermission('ROLE_FINANCE'),
        // ...
    ];
}
```

--------------------------------

### Restrict Access to Menu Items

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Example of using `setPermission()` to restrict access to a menu item.

```php
public function configureMenuItems(): iterable
{
    return [
        // ...

        MenuItem::linkTo(BlogPostCrudController::class, 'Blog Posts')
            ->setPermission('ROLE_EDITOR'),
    ];
}
```

--------------------------------

### PHP Enum Support - TranslatableInterface

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ChoiceField.html

Example of implementing TranslatableInterface in a PHP Enum for translatable labels.

```php
use Symfony\Contracts\Translation\TranslatableInterface;
use Symfony\Contracts\Translation\TranslatorInterface;

enum Status: string implements TranslatableInterface
{
    // ...

    public function trans(TranslatorInterface $translator, ?string $locale = null): string
    {
        return $translator->trans(
            match($this) {
                self::Draft => 'Draft 📝',
                self::Published => 'Published ✅',
                self::Deleted => 'Deleted ❌',
            },
            locale: $locale
        );
    }
}
```

--------------------------------

### Restrict Entity Access

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Example of using `setEntityPermission()` to restrict access to entities on index and detail pages.

```php
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class ProductCrudController extends AbstractCrudController
{
    // ...

    public function configureCrud(Crud $crud): Crud
    {
        return $crud
            ->setEntityPermission('ROLE_ADMIN')
            // ...
        ;
    }
}
```

--------------------------------

### Define Custom Field Options with FieldTrait

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Define custom options for a field by declaring public constants and using `setCustomOption()` from `FieldTrait`. This example shows how to configure a `MapField` to use different map providers.

```php
namespace App\Admin\Field;

use EasyCorp\Bundle\EasyAdminBundle\Contracts\Field\FieldInterface;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;

final class MapField implements FieldInterface
{
    use FieldTrait;

    public const OPTION_MAP_PROVIDER = 'mapProvider';

    public static function new(string $propertyName, ?string $label = null): self
    {
        return (new self()) 
            // ...
            ->setCustomOption(self::OPTION_MAP_PROVIDER, 'openstreetmap')
        ;
    }

    public function useGoogleMaps(): self
    {
        $this->setCustomOption(self::OPTION_MAP_PROVIDER, 'google');

        return $this;
    }

    public function useOpenStreetMap(): self
    {
        $this->setCustomOption(self::OPTION_MAP_PROVIDER, 'openstreetmap');

        return $this;
    }
}
```

--------------------------------

### Set Uploaded File Name Pattern with Closure

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Use a closure to dynamically generate the uploaded file name pattern. This example generates a random number prefix and uses the original filename.

```php
yield FileField::new('...')->setUploadedFileNamePattern(
    fn (UploadedFile $file): string => sprintf('upload_%d_%s.%s', random_int(1, 999), $file->getFilename(), $file->guessExtension()))
);
```

--------------------------------

### Rendering as Native Widget

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/AssociationField.html

Example of using `renderAsNativeWidget()` to display a standard `<select>` element instead of the default JavaScript widget.

```php
yield AssociationField::new('...')->renderAsNativeWidget();
```

--------------------------------

### TextEditorField with Trix Editor Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TextEditorField.html

This example shows how to pass configuration options to the Trix editor.

```php
yield TextEditorField::new('...')->setTrixEditorConfig([
    'blockAttributes' => [
        'default' => ['tagName' => 'p'],
        'heading1' => ['tagName' => 'h2'],
    ],
    'css' => [
        'attachment' => 'admin_file_field_attachment',
    ],
]);
```

--------------------------------

### Functional Test Case Example

Source: https://symfony.com/bundles/EasyAdminBundle/current/tests.html

Example of a functional test class for a Category CRUD controller, extending AbstractCrudTestCase.

```php
namespace App\Tests\Admin\Controller;

use App\Controller\Admin\AppDashboardController;
use App\Controller\Admin\CategoryCrudController;
use EasyCorp\Bundle\EasyAdminBundle\Test\AbstractCrudTestCase;

final class CategoryCrudControllerTest extends AbstractCrudTestCase
{
    protected function getControllerFqcn(): string
    {
        return CategoryCrudController::class;
    }

    protected function getDashboardFqcn(): string
    {
        return AppDashboardController::class;
    }

    public function testIndexPage(): void
    {
        // this examples doesn't use security; in your application you may
        // need to ensure that the user is logged before the test
        $this->client->request("GET", $this->generateIndexUrl());
        static::assertResponseIsSuccessful();
    }
}
```

--------------------------------

### Advanced Web Asset Configuration with Asset Class

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Demonstrates fine-grained control over web asset loading using the Asset class, including conditions like 'ignoreOnForm', 'onlyOnIndex', and 'onlyWhenCreating'.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Asset;
// ...

TextField::new('firstName', 'Name')
    ->addCssFiles(Asset::new('bundle/some-bundle/foo.css')->ignoreOnForm()->htmlAttr('media', 'print'))
    ->addJsFiles(Asset::new('admin/some-custom-code.js')->onlyOnIndex()->defer())
    ->addWebpackEncoreEntries(Asset::new('admin-maps')->onlyWhenCreating()->preload())
    ->addRepriseEntries(Asset::new('admin-maps')->onlyWhenCreating()->reprisePackageName('legacy_assets'))
    ->addCssFiles(Asset::new('some-path/bar.css')->package('legacy_assets'));
```

--------------------------------

### Build Admin URLs with AdminUrlGenerator

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Demonstrates using the AdminUrlGenerator service to build backend URLs dynamically, maintaining existing query parameters or removing them.

```php
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;
use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;

class SomeCrudController extends AbstractCrudController
{
    private $adminUrlGenerator;

    public function __construct(AdminUrlGenerator $adminUrlGenerator)
    {
        $this->adminUrlGenerator = $adminUrlGenerator;
    }

    // ...

    public function someMethod()
    {
        // instead of injecting the AdminUrlGenerator service in the constructor,
        // you can also get it from inside a controller action as follows:
        // $adminUrlGenerator = $this->container->get(AdminUrlGenerator::class);

        // the existing query parameters are maintained, so you only
        // have to pass the values you want to change.
        $url = $this->adminUrlGenerator->set('page', 2)->generateUrl();

        // you can remove existing parameters
        $url = $this->adminUrlGenerator->unset('page')->generateUrl();
        $url = $this->adminUrlGenerator->unsetAll()->set('foo', 'someValue')->generateUrl();

        // the URL builder provides shortcuts for the most common parameters
        $url = $this->adminUrlGenerator
            ->setController(SomeCrudController::class)
            ->setAction('theActionName')
            ->generateUrl();

        // ...
    }
}
```

--------------------------------

### Configure Image Upload Directory

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Use setUploadDir to change the default directory where uploaded images are stored. The path is relative to your project root.

```php
yield ImageField::new('...')->setUploadDir('assets/images/');
// the property will only store the file path relative to this dir
// (e.g. 'logo.png', 'venue/layout.jpg')
```

--------------------------------

### Configure Field Labels

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Demonstrates different ways to set labels for fields, including automatic generation, null, empty string, false, and explicit HTML content.

```php
TextField::new('firstName'),
TextField::new('firstName', null),
```

```php
TextField::new('firstName', false)
```

```php
TextField::new('firstName', 'Customer <b>Name</b>')
```

--------------------------------

### Basic Usage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TimeField.html

Example of how to use the TimeField in a form page.

```php
yield TimeField::new('...')->renderAsChoice();
```

--------------------------------

### showSample option

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ColorField.html

If you prefer to not display that sample, use this option:

```php
yield ColorField::new('...')->showSample(false);
```

--------------------------------

### Add Web Assets to Fields

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Illustrates how to include CSS files, JavaScript files, Webpack Encore entries, and Symfony Reprise entries for a field.

```php
TextField::new('firstName', 'Name')
    ->addCssFiles('bundle/some-bundle/foo.css', 'some-custom-styles.css')
    ->addJsFiles('admin/some-custom-code.js')
    ->addWebpackEncoreEntries('admin-maps')
    ->addRepriseEntries('admin-maps')
    ->addHtmlContentsToHead('<link rel="dns-prefetch" href="https://assets.example.com">')
    ->addHtmlContentsToBody('<!-- generated at '.time().' -->');
```

--------------------------------

### LocaleField Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/LocaleField.html

Example of how to configure the LocaleField to hide the locale name.

```php
yield LocaleField::new('...')->showName(false);
```

--------------------------------

### Configure ImageField with Flysystem Storage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Use `setFlysystemStorage()` to specify the Flysystem storage service ID. The `setUploadDir()` and `setUploadedFileNamePattern()` options work with the Flysystem path.

```php
yield ImageField::new('photo')
    ->setFlysystemStorage('default.storage')
    ->setUploadDir('images/')
    ->setUploadedFileNamePattern('[uuid].[extension]');
```

--------------------------------

### Responsive Form Columns with Bootstrap Classes

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

This example shows how to define responsive columns using specific Bootstrap classes. Columns adjust their width based on screen size breakpoints (e.g., `lg` and `xl`).

```php
use EasyCorp\Bundle\EasyAdminBundle\Field\FormField;

public function configureFields(string $pageName): iterable
{
    return [
        FormField::addColumn('col-lg-8 col-xl-6'),
        TextField::new('firstName'),
        TextField::new('lastName'),

        FormField::addColumn('col-lg-3 col-xl-2'),
        TextField::new('phone'),
        TextField::new('email')->hideOnIndex(),
    ];
}
```

--------------------------------

### Set Currency

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Example of setting a fixed currency for the MoneyField.

```php
yield MoneyField('...')->setCurrency('INR');
```

--------------------------------

### Define Uploaded File Name Pattern

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Use setUploadedFileNamePattern to customize how uploaded image files are named. Supports various placeholders for date, time, original name, and hashes.

```php
yield ImageField::new('...')
    ->setUploadedFileNamePattern('[YYYY]/[MM]/[DD]/[slug]-[contenthash].[extension]');
```

--------------------------------

### LocaleField Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/LocaleField.html

Example of how to configure the LocaleField to show the locale code.

```php
yield LocaleField::new('...')->showCode();
```

--------------------------------

### LocaleField Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/LocaleField.html

Example of how to configure the LocaleField to remove specific locales.

```php
yield LocaleField::new('...')->remove(['fr', 'pl']);
```

--------------------------------

### Apply Form Theme and CSS Classes

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Shows how to add specific form themes and CSS classes to a field for styling and rendering.

```php
TextField::new('firstName', 'Name')
    ->addFormTheme('@FOSCKEditor/Form/ckeditor_widget.html.twig')
    ->addFormTheme('theme1.html.twig', 'theme2.html.twig', 'theme3.html.twig')
    ->addCssClass('text-large text-bold')
    ->setCssClass('text-large text-bold')
    ->setTemplatePath('admin/fields/my_template.html.twig')
    ->setTextAlign('right');
```

--------------------------------

### Configure Assets with a Custom Icon Set Prefix

Source: https://symfony.com/bundles/EasyAdminBundle/current/design.html

If all your custom icons share a common prefix (e.g., 'tabler:'), you can specify it in `useCustomIconSet()` to simplify icon naming.

```php
return Assets::new()->useCustomIconSet('tabler');
```

--------------------------------

### LocaleField Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/LocaleField.html

Example of how to configure the LocaleField to include only specific locales.

```php
yield LocaleField::new('...')->includeOnly(['en', 'fr', 'pl']);
```

--------------------------------

### List All Admin Routes

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Use this command to list all CRUD action routes generated by EasyAdmin.

```bash
$ php bin/console debug:router
```

--------------------------------

### SlugField::setUnlockConfirmationMessage

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/SlugField.html

Example of how to customize the unlock confirmation message for the SlugField.

```php
yield SlugField::new('...')->setUnlockConfirmationMessage(
    'It is highly recommended to use the automatic slugs, but you can customize them'
);
```

--------------------------------

### Disable Deleting Items

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/CollectionField.html

Example of how to disable deleting items from the collection.

```php
yield CollectionField::new('...')->allowDelete(false);
```

--------------------------------

### Configure Basic Filters

Source: https://symfony.com/bundles/EasyAdminBundle/current/filters.html

Define basic filters for entity properties like 'title', 'price', and 'published' in the `configureFilters` method.

```php
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Filters;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class ProductCrudController extends AbstractCrudController
{
    // ...

    public function configureFilters(Filters $filters): Filters
    {
        return $filters
            ->add('title')
            ->add('price')
            ->add('published')
        ;
    }
}
```

--------------------------------

### Entity with Collections

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/CollectionField.html

Example of a BlogPost entity with one-to-many and many-to-many relations.

```php
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
// ...

class BlogPost
{
    // ...

    #[ORM\OneToMany(targetEntity: Comment::class, mappedBy: 'post', orphanRemoval: true, cascade: ['persist'])]
    private Collection $comments;

    #[ORM\ManyToMany(targetEntity: Tag::class, cascade: ['persist'])]
    #[ORM\JoinTable(name: 'my_app_blogpost_tag')]
    private Collection $tags;
}
```

--------------------------------

### Create Global Action Groups for Index Page

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

Define action groups that apply to the entire index page, not specific entities. This example creates a 'create' group for post-related actions and a 'send' group for communication actions.

```php
public function configureActions(Actions $actions): Actions
{
    $createActions = ActionGroup::new('create')
        ->createAsGlobalActionGroup()
        ->addAction(Action::new('new', 'Create Post')->linkToCrudAction('...'))
        ->addAction(Action::new('draft', 'Draft Post')->linkToCrudAction('...'))
        ->addAction(Action::new('template', 'Create from Template')->linkToCrudAction('...'));

    $sendActions = ActionGroup::new('send', 'Send ...')
        ->addAction(Action::new('sendEmail', 'Send by Email')->linkToCrudAction('...'))
        ->addAction(Action::new('sendSlack', 'Send to Slack')->linkToCrudAction('...'))
        ->addAction(Action::new('sendTelegram', 'Send via Telegram')->linkToCrudAction('...'));

    return $actions
        // ...
        ->add(Crud::PAGE_INDEX, $createActions)
        ->add(Crud::PAGE_INDEX, $sendActions)
    ;
}
```

--------------------------------

### Use Money Object

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Example of enabling the use of Money objects for the field.

```php
yield MoneyField::new('price')->useMoneyObject();
```

--------------------------------

### Customizing Fieldset Rendering with propertySuffix

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Shows how to use the `propertySuffix` argument with `addFieldset()` to customize the rendering of a specific fieldset. This is useful for overriding the default template.

```php
FormField::addFieldset('Contact information', propertySuffix: 'contact');
```

--------------------------------

### Create Translatable Messages

Source: https://symfony.com/bundles/EasyAdminBundle/current/dashboards.html

Demonstrates creating translatable messages using TranslatableMessage objects or the t() function shortcut. These are useful for defining text content within your backend.

```php
use Symfony\Component\Translation\TranslatableMessage;
use function Symfony\Component\Translation\t;

// creating translatable messages using objects
TextField::new('firstName', new TranslatableMessage('Name'))
TextField::new('firstName', new TranslatableMessage('Name', ['parameter' => 'value'], 'admin'))

// creating translatable messages using the t() function shortcut
TextField::new('firstName', t('Name'))
TextField::new('firstName', t('Name', ['parameter' => 'value'], 'admin'))
```

--------------------------------

### Disable Adding Items

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/CollectionField.html

Example of how to disable adding new items to the collection.

```php
yield CollectionField::new('...')->allowAdd(false);
```

--------------------------------

### Generate Dynamic Action Label Using a Repository Service

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

Use a service, like a Doctrine repository, within a closure to compute a dynamic action label. This allows for more complex data retrieval to determine the label text, such as counting payments via a repository method.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;

private InvoicePaymentRepository $invoicePaymentRepository;

public function __construct(InvoicePaymentRepository $invoicePaymentRepository)
{
    $this->invoicePaymentRepository = $invoicePaymentRepository;
}

public function configureActions(Actions $actions): Actions
{
    $viewPayments = Action::new('payments')
        ->setLabel(function (Invoice $invoice)) {
            return $this->invoicePaymentRepository->countByInvoice($invoice) . ' payments';
        });

    return $actions
        // ...
        ->add(Crud::PAGE_DETAIL, $viewPayments);
}
```

--------------------------------

### Restrict Access to Actions

Source: https://symfony.com/bundles/EasyAdminBundle/current/security.html

Example of using `setPermission()` to define security permissions for actions.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;

public function configureActions(Actions $actions): Actions
{
    $viewInvoice = Action::new('invoice', 'View invoice', 'fa fa-file-invoice')
        ->linkToCrudAction('renderInvoice');

    return $actions
        // ...
        ->add(Crud::PAGE_DETAIL, $viewInvoice)
        // use the 'setPermission()' method to set the permission of actions
        // (the same permission is granted to the action on all pages)
        ->setPermission('invoice', 'ROLE_FINANCE')

        // you can set permissions for built-in actions in the same way
        ->setPermission(Action::NEW, 'ROLE_ADMIN')
    ;
}
```

--------------------------------

### Add Confirmation to Actions with askConfirmation()

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

Enable a confirmation prompt before executing an action by using the `askConfirmation()` method. This is useful for destructive or important actions.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;

public function configureActions(Actions $actions): Actions
{
    $archiveAction = Action::new('archive', 'Archive')
        ->linkToCrudAction('archive')
        ->askConfirmation();

    return $actions
        ->add(Crud::PAGE_INDEX, $archiveAction);
}
```

--------------------------------

### Set Timezone

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TimeField.html

Example of overriding the default timezone for displaying time in read-only pages.

```php
yield TimeField::new('...')->setTimezone('America/Mexico_City');
```

--------------------------------

### stripTags option

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TextareaField.html

Example of using stripTags() to strip HTML tags from the content before displaying it.

```php
> // if original contents are <strong>foo</strong>, it only displays `foo` yield TextareaField::new('...')->stripTags();
```

--------------------------------

### ChoiceField::new()

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ChoiceField.html

This is the basic way to instantiate a ChoiceField.

```php
yield ChoiceField::new('...');
```

--------------------------------

### Apply Responsive Classes with Offset and Order

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields.html

Combine responsive column classes with offset and order classes to precisely control field placement within a row.

```php
yield DateTimeField::new('endsAt')->setColumns('col-sm-6 col-xxl-3 offset-lg-1 order-3');
```

--------------------------------

### SlugField::new

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/SlugField.html

Example of how to use SlugField::new to set the target field name.

```php
yield SlugField::new('...')->setTargetFieldName('title');
```

--------------------------------

### Setting Translatable Choices

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ChoiceField.html

Example of using `setTranslatableChoices` to define choices with translatable labels.

```php
use function Symfony\Component\Translation\t;
// ...

yield ChoiceField::new('...')->setTranslatableChoices([
    'paid' => t('Paid Invoice'),
    'pending' => t('Invoice Sent but Unpaid'),
    // if you want, some choices can use strings instead of objects
    'refunded' => 'Refunded Invoice',
]);
```

--------------------------------

### Custom Uploaded File Name Pattern with Closure

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Provide a closure to setUploadedFileNamePattern for dynamic file naming based on the UploadedFile instance. Allows for custom logic like generating random numbers.

```php
yield ImageField::new('...')->setUploadedFileNamePattern(
    fn (UploadedFile $file): string => sprintf('upload_%d_%s.%s', random_int(1, 999), $file->getFilename(), $file->guessExtension()))
);
```

--------------------------------

### setEntryToStringMethod

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/CollectionField.html

Defines how to get the string representation of each collection entry. This can be a method name or a callable.

```php
yield CollectionField::new('...')->setEntryToStringMethod('getFullName');

// you can also pass a callable to generate the string
yield CollectionField::new('...')->setEntryToStringMethod(fn (): string => '...');
// your callable receives the entity and the translator service as arguments
yield CollectionField::new('...')->setEntryToStringMethod(
    fn (Category $value, TranslatorInterface $translator): string => $translator->trans($value->getDescription())
);
```

--------------------------------

### Adding Custom Assets with configureAssets()

Source: https://symfony.com/bundles/EasyAdminBundle/current/design.html

Use this method in your CRUD controllers to import assets using AssetMapper, Webpack Encore, Symfony Reprise, or direct file paths. You can also add raw HTML content to the head or body.

```php
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Assets;
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class ProductCrudController extends AbstractCrudController
{
    // ...

    public function configureAssets(Assets $assets): Assets
    {
        return $assets
            // imports the given entrypoint defined in the importmap.php file of AssetMapper
            // it's equivalent to adding this inside the <head> element:
            // {{ importmap('admin') }}
            ->addAssetMapperEntry('admin')
            // you can also import multiple entries
            // it's equivalent to calling {{ importmap(['app', 'admin']) }}
            ->addAssetMapperEntry('app', 'admin')

            // adds the CSS and JS assets associated to the given Webpack Encore entry
            // it's equivalent to adding these inside the <head> element:
            // {{ encore_entry_link_tags('...') }} and {{ encore_entry_script_tags('...') }}
            ->addWebpackEncoreEntry('admin-app')

            // adds the CSS and JS assets associated to the given Symfony Reprise entry
            // it's equivalent to adding these inside the <head> element:
            // {{ reprise_entry_link_tags('...') }} and {{ reprise_entry_script_tags('...') }}
            ->addRepriseEntry('admin-app')

            // it's equivalent to adding this inside the <head> element:
            // <link rel="stylesheet" href="{{ asset('...') }}">
            ->addCssFile('build/admin.css')
            ->addCssFile('https://example.org/css/admin2.css')

            // it's equivalent to adding this inside the <head> element:
            // <script src="{{ asset('...') }}"></script>
            ->addJsFile('build/admin.js')
            ->addJsFile('https://example.org/js/admin2.js')

            // use these generic methods to add any code before </head> or </body>
            // the contents are included "as is" in the rendered page (without escaping them)
            ->addHtmlContentToHead('<link rel="dns-prefetch" href="https://assets.example.com">')
            ->addHtmlContentToBody('<script> ... </script>')
            ->addHtmlContentToBody('<!-- generated at '.time().' -->')
        ;
    }
}
```

--------------------------------

### Create and Add Global Action to Index Page

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

Define a custom global action that links to an external URL and add it to the index page. Ensure the Action class is imported.

```php
$goToStripe = Action::new('goToStripe')
    ->linkToUrl('https://www.stripe.com/')
    ->createAsGlobalAction()
;

$actions->add(Crud::PAGE_INDEX, $goToStripe);
```

--------------------------------

### Set Format (Predefined)

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TimeField.html

Example of setting a predefined format for displaying time in read-only pages.

```php
// these are the predefined formats: 'short', 'medium', 'long', 'full'
yield TimeField::new('...')->setFormat('long');

// predefined formats are available as constants too
use EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField;

yield TimeField::new('...')->setFormat(DateTimeField::FORMAT_LONG);
```

--------------------------------

### Set Maximum Image Size (Suffixed String)

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

The `maxSize` option accepts suffixed strings like '5M' for megabytes, making it easy to define size limits using human-readable values.

```PHP
yield ImageField::new('...')->maxSize('5M');
```

--------------------------------

### ActionMenu with Selectable Items (RadioList)

Source: https://symfony.com/bundles/EasyAdminBundle/current/components.html

Demonstrates how to create selectable items within an ActionMenu using the RadioList component. This allows for mutually exclusive options, indicated by a trailing checkmark. The 'selected' prop controls the initial selection state.

```twig
<twig:ea:ActionMenu:ActionList>
    <twig:ea:ActionMenu:ActionList:RadioList label="Theme">
        <twig:ea:ActionMenu:ActionList:Item label="Light" url="?theme=light" selected="{{ theme == 'light' }}"/>
        <twig:ea:ActionMenu:ActionList:Item label="Dark" url="?theme=dark" selected="{{ theme == 'dark' }}"/>
    </twig:ea:ActionMenu:ActionList:RadioList>
</twig:ea:ActionMenu:ActionList>
```

--------------------------------

### Use Money Object with Custom Currency

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Example of using Money objects and overriding the currency.

```php
yield MoneyField::new('price')->useMoneyObject()->setCurrency('EUR');
```

--------------------------------

### Generate CRUD Controller

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Use this command to generate the basic structure for a new CRUD controller.

```bash
$ php bin/console make:admin:crud
```

--------------------------------

### Set Stored as Cents

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Example of disabling the default behavior of storing money amounts as cents.

```php
> yield MoneyField::new('...')->setStoredAsCents(false);
```

--------------------------------

### Set Accepted MIME Types (Extensions)

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/ImageField.html

Use the `mimeTypes` option to specify accepted file types using comma-separated extensions. This restricts the file dialog to the desired image formats.

```PHP
yield ImageField::new('...')->mimeTypes('.png,.jpg,.webp');
```

--------------------------------

### Set Number of Decimals

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Example of setting the number of decimal places for displaying money amounts.

```php
yield MoneyField::new('...')->setNumDecimals(0);
```

--------------------------------

### Set Currency Property Path

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/MoneyField.html

Examples of setting the property path to retrieve the currency from the entity.

```php
yield MoneyField('...')->setCurrencyPropertyPath('currency');
yield MoneyField('...')->setCurrencyPropertyPath('currencySymbol');
yield MoneyField('...')->setCurrencyPropertyPath('currency.code');
```

--------------------------------

### Create a Menu Section

Source: https://symfony.com/bundles/EasyAdminBundle/current/dashboards.html

Use MenuItem::section() to create a visual separator in the menu. Optionally, provide a string to display a title for the section.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        // ...

        MenuItem::section(),
        // ...

        MenuItem::section('Blog'),
        // ...
    ];
}
```

--------------------------------

### Rendering as Embedded Form

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/AssociationField.html

Example of using `renderAsEmbeddedForm()` to embed the CRUD form of an associated property.

```php
yield AssociationField::new('...')->renderAsEmbeddedForm();
```

--------------------------------

### Link to Absolute URL with Icon

Source: https://symfony.com/bundles/EasyAdminBundle/current/dashboards.html

Creates a menu item that links to an absolute URL, including an icon for visual representation.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

// ...

MenuItem::linkToUrl('Search in Google', 'fab fa-google', 'https://google.com')
```

--------------------------------

### Conditional Autocomplete Enablement

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/AssociationField.html

Example showing how to conditionally enable the autocomplete feature based on a variable.

```php
yield AssociationField::new('city')->autocomplete(
    enable: $cityCount > 50,
    callback: static fn (City $c): string => sprintf('%s, %s', $c->getName(), $c->getState()->getCode())
);
```

--------------------------------

### Configure Assets for Charts

Source: https://symfony.com/bundles/EasyAdminBundle/current/dashboards.html

This method is used to configure assets, such as CSS and JavaScript, required for rendering charts on the dashboard. It uses `Assets::new()` to create a new asset configuration and `addAssetMapperEntry('charts')` to include the necessary chart assets.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Assets;

// ...

public function configureAssets(): Assets
{
    return Assets::new()
        ->addAssetMapperEntry('charts');
}
```

--------------------------------

### Adding Actions to Alerts

Source: https://symfony.com/bundles/EasyAdminBundle/current/components.html

Include buttons or links within the 'actions' block of an alert to guide users on necessary actions.

```twig
<twig:ea:Alert variant="info" title="New version available">
    A new EasyAdmin version has been released.

    <twig:block name="actions">
        <twig:ea:Button htmlElement="a" href="/changelog" size="sm">Read the changelog</twig:ea:Button>
    </twig:block>
</twig:ea:Alert>
```

--------------------------------

### Configure File Base Path

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/FileField.html

Set the base path for files displayed in read-only pages. Use this when files are served under a specific directory.

```php
yield FileField::new('...')->setBasePath('uploads/files/');
```

--------------------------------

### Generate Admin URL in Twig Template

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Example of generating an admin URL within a Twig template using the path function.

```twig
// generating an admin URL in a Twig template
<a href="{{ path('admin_blog_post_edit', {entityId: post.id}) }}">Edit Blog Post</a>
```

--------------------------------

### Generate Admin URLs in Controller

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Examples of generating admin URLs within a Symfony controller using redirectToRoute or the router service.

```php
// redirecting to an admin URL inside a controller
return $this->redirectToRoute('admin_product_new');

// generating an admin URL inside a service
$userProfileUrl = $this->router->generate('admin_user_detail', [
    'entityId' => $user->getId(),
]);
```

--------------------------------

### Add Batch Action Configuration

Source: https://symfony.com/bundles/EasyAdminBundle/current/actions.html

Configure a batch action using `addBatchAction()` within `configureActions`. It can link to a CRUD controller method, specify a label, CSS class, and icon.

```php
namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;

class UserCrudController extends AbstractCrudController
{
    // ...

    public function configureActions(Actions $actions): Actions
    {
        return $actions
            // ...
            ->addBatchAction(Action::new('approve', 'Approve Users')
                ->linkToCrudAction('approveUsers')
                ->addCssClass('btn btn-primary')
                ->setIcon('fa fa-user-check'))
        ;
    }
}
```

--------------------------------

### Configure Default Autocomplete Callback

Source: https://symfony.com/bundles/EasyAdminBundle/current/crud.html

Sets a default callback for all autocomplete fields to format the displayed entity. Uses the entity's 'getFullName' method if available, otherwise casts the entity to a string.

```php
use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;

public function configureCrud(Crud $crud): Crud
{
    return $crud
        ->autocomplete(
            callback: static fn ($entity): string => method_exists($entity, 'getFullName') ? $entity->getFullName() : (string) $entity
        )
    ;
}
```

--------------------------------

### Set Format (Custom ICU)

Source: https://symfony.com/bundles/EasyAdminBundle/current/fields/TimeField.html

Example of setting a custom ICU Datetime Pattern for displaying time.

```php
yield TimeField::new('...')->setFormat('HH:mm:ss zzz');
yield TimeField::new('...')->setFormat('K:mm a, z');
```
Tokens:
Raw