CRUD Controllers

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use EasyCorp\Bundle\EasyAdminBundle\Attribute\AdminDashboard;
// ...

#[AdminDashboard(routes: [
    'index' => ['routePath' => '/all']
    'new' => ['routePath' => '/create', 'routeName' => 'create'],
    'edit' => ['routePath' => '/editing-{entityId}', 'routeName' => 'editing'],
    'delete' => ['routePath' => '/remove/{entityId}'],
    'detail' => ['routeName' => 'view'],
])]
class SomeDashboardController extends AbstractDashboardController
{
    // ...
}

1
2
3
4
5
6
7
8
9
10
11
12
13

use EasyCorp\Bundle\EasyAdminBundle\Attribute\AdminAction;
// ...

class ProductCrudController extends AbstractCrudController
{
    // ...

    #[AdminAction(routePath: '/latest-products', routeName: 'latest')]
    public function index(AdminContext $context)
    {
        // ...
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // set this option if you prefer the page content to span the entire
        // browser width, instead of the default design which sets a max width
        ->renderContentMaximized()

        // set this option if you prefer the sidebar (which contains the main menu)
        // to be displayed as a narrow column instead of the default expanded design
        ->renderSidebarMinimized()
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // the labels used to refer to this entity in titles, buttons, etc.
        ->setEntityLabelInSingular('Product')
        ->setEntityLabelInPlural('Products')

        // in addition to a string, the argument of the singular and plural label methods
        // can be a closure that defines two nullable arguments: entityInstance (which will
        // be null in 'index' and 'new' pages) and the current page name
        ->setEntityLabelInSingular(
            fn (?Product $product, ?string $pageName) => $product ? $product->toString() : 'Product'
        )
        ->setEntityLabelInPlural(function (?Category $category, ?string $pageName) {
            return 'edit' === $pageName ? $category->getLabel() : 'Categories';
        })

        // the Symfony Security permission needed to manage the entity
        // (none by default, so you can manage all instances of the entity)
        ->setEntityPermission('ROLE_EDITOR')
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // the visible title at the top of the page and the content of the <title> element
        // it can include these placeholders:
        //   %entity_name%, %entity_as_string%,
        //   %entity_id%, %entity_short_id%
        //   %entity_label_singular%, %entity_label_plural%
        ->setPageTitle('index', '%entity_label_plural% listing')

        // you can pass a PHP closure as the value of the title
        ->setPageTitle('new', fn () => new \DateTime('now') > new \DateTime('today 13:00') ? 'New dinner' : 'New lunch')

        // in DETAIL and EDIT pages, the closure receives the current entity
        // as the first argument
        ->setPageTitle('detail', fn (Product $product) => (string) $product)
        ->setPageTitle('edit', fn (Category $category) => sprintf('Editing <b>%s</b>', $category->getName()))

        // the help message displayed to end users (it can contain HTML tags)
        ->setHelp('edit', '...')
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // the argument must be either one of these strings: 'short', 'medium', 'long', 'full', 'none'
        // (the strings are also available as \EasyCorp\Bundle\EasyAdminBundle\Field\DateTimeField::FORMAT_* constants)
        // or a valid ICU Datetime Pattern (see https://unicode-org.github.io/icu/userguide/format_parse/datetime/)
        ->setDateFormat('...')
        ->setTimeFormat('...')

        // first argument = datetime pattern or date format; second optional argument = time format
        ->setDateTimeFormat('...', '...')

        ->setDateIntervalFormat('%%y Year(s) %%m Month(s) %%d Day(s)')
        ->setTimezone('...')

        // this option makes numeric values to be rendered with a sprintf()
        // call using this value as the first argument.
        // this option overrides any formatting option for all numeric values
        // (e.g. setNumDecimals(), setRoundingMode(), etc. are ignored)
        // NumberField and IntegerField can override this value with their
        // own setNumberFormat() methods, which works in the same way
        ->setNumberFormat('%.2d')

        // Sets the character used to separate each thousand group in a number
        // e.g. if separator is ',' then 12345 is formatted as 12,345
        // By default, EasyAdmin doesn't add any thousands separator to numbers;
        // NumberField and IntegerField can override this value with their
        // own setThousandsSeparator() methods, which works in the same way
        ->setThousandsSeparator(',')

        // Sets the character used to separate the decimal part of a non-integer number
        // e.g. if separator is '.' then 1/10 is formatted as 0.1
        // by default, EasyAdmin displays the default decimal separator used by PHP;
        // NumberField and IntegerField can override this value with their
        // own setDecimalSeparator() methods, which works in the same way
        ->setDecimalSeparator('.')
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // ...

        // the names of the Doctrine entity properties where the search is made on
        // (by default it looks for in all properties)
        ->setSearchFields(['name', 'description'])
        // use dots (e.g. 'seller.email') to search in Doctrine associations
        ->setSearchFields(['name', 'description', 'seller.email', 'seller.address.zipCode'])
        // set it to null to disable and hide the search box
        ->setSearchFields(null)
        // call this method to focus the search input automatically when loading the 'index' page
        ->setAutofocusSearch()

        // by default, the search results match all the terms (SearchMode::ALL_TERMS):
        // term1 in (field1 or field2) AND term2 in (field1 or field2)
        // e.g. if you look for 'lorem ipsum' in [title, description],
        // results require matching 'lorem' in either title or description
        // (or both) AND 'ipsum' in either title or description (or both)
        ->setSearchMode(SearchMode::ALL_TERMS)

        // use the SearchMode::ANY_TERMS option to change the search mode to
        // match at least one of the terms:
        // term1 in (field1 or field2) OR term2 in (field1 or field2)
        // e.g. if you look for 'lorem ipsum' in [title, description],
        // results will match either 'lorem' in title or description (or both)
        // OR 'ipsum' in title or description (or both)
        ->setSearchMode(SearchMode::ANY_TERMS)
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // ...

        // defines the initial sorting applied to the list of entities
        // (user can later change this sorting by clicking on the table columns)
        ->setDefaultSort(['id' => 'DESC'])
        ->setDefaultSort(['id' => 'DESC', 'title' => 'ASC', 'startsAt' => 'DESC'])
        // you can sort by Doctrine associations up to two levels
        ->setDefaultSort(['seller.name' => 'ASC'])
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // ...

        // the max number of entities to display per page
        ->setPaginatorPageSize(30)
        // the number of pages to display on each side of the current page
        // e.g. if num pages = 35, current page = 7 and you set ->setPaginatorRangeSize(4)
        // the paginator displays: [Previous]  1 ... 3  4  5  6  [7]  8  9  10  11 ... 35  [Next]
        // set this number to 0 to display a simple "< Previous | Next >" pager
        ->setPaginatorRangeSize(4)

        // these are advanced options related to Doctrine Pagination
        // (see https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/tutorials/pagination.html)
        ->setPaginatorUseOutputWalkers(true)
        ->setPaginatorFetchJoinCollection(true)
    ;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // this method allows to use your own template to render a certain part
        // of the backend instead of using EasyAdmin default template
        // the first argument is the "template name", which is the same as the
        // Twig path but without the `@EasyAdmin/` prefix and the `.html.twig` suffix
        ->overrideTemplate('crud/field/id', 'admin/fields/my_id.html.twig')

        // the theme/themes to use when rendering the forms of this entity
        // (in addition to EasyAdmin default theme)
        ->addFormTheme('foo.html.twig')
        // this method overrides all existing form themes (including the
        // default EasyAdmin form theme)
        ->setFormThemes(['my_theme.html.twig', 'admin.html.twig'])

        // this sets the options of the entire form (later, you can set the options
        // of each form type via the methods of their associated fields)
        // pass a single array argument to apply the same options for the new and edit forms
        ->setFormOptions([
            'validation_groups' => ['Default', 'my_validation_group']
        ]);

        // pass two array arguments to apply different options for the new and edit forms
        // (pass an empty array argument if you want to apply no options to some form)
        ->setFormOptions(
            ['validation_groups' => ['my_validation_group']],
            ['validation_groups' => ['Default'], '...' => '...'],
        );
    ;
}

1
2
3
4
5
6
7
8
9
10
11

public function configureCrud(Crud $crud): Crud
{
    return $crud
        // by default, when the value of some field is `null`, EasyAdmin displays
        // a label with the `null` text. You can change that by overriding
        // the `label/null` template. However, if you have lots of `null` values
        // and want to reduce the "visual noise" in your backend, you can use
        // the following option to not display anything when some value is `null`
        // (this option is applied both in the `index` and `detail` pages)
        ->hideNullValues()
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

protected function getRedirectResponseAfterSave(AdminContext $context, string $action): RedirectResponse
{
    $submitButtonName = $context->getRequest()->request->all()['ea']['newForm']['btn'];

    if ('saveAndViewDetail' === $submitButtonName) {
        // when using pretty admin URLs
        return $this->redirectToRoute('admin_product_detail', [
            'entityId' => $context->getEntity()->getPrimaryKeyValue(),
        ]);

        // when using legacy admin URLs
        $url = $this->container->get(AdminUrlGenerator::class)
            ->setAction(Action::DETAIL)
            ->setEntityId($context->getEntity()->getPrimaryKeyValue())
            ->generateUrl();

        return $this->redirect($url);
    }

    return parent::getRedirectResponseAfterSave($context, $action);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureCrud(): Crud
    {
        return Crud::new()
            // this defines the pagination size for all CRUD controllers
            // (each CRUD controller can override this value if needed)
            ->setPaginatorPageSize(30)
        ;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

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('menuIndex')->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();

        // ...
    }
}