CRUD Controller¶

Actions¶

The five main actions of the CRUD Controller are:

• List - Display a list of entities that can be paginated, filtered, and sorted, etc.
• Detail - Display detail of an entity (read-only)
• Create - Allows to create a new entity.
• Edit - Allows to edit an existing entity.
• Delete - Action to delete an entity.

Routes¶

Crud controller generates pretty URLs for each action. The URL is generated based on the Controller name.

• PriceListController -> /admin/price-list/ (Same for PriceListCrudController)
• OrderController -> /admin/order/

ActionType	Route name	Route path
list	admin_crud_{controller_name}_list	/admin/{controller-name}/
detail	admin_crud_{controller_name}_detail	/admin/{controller-name}/detail/{entityId}
create	admin_crud_{controller_name}_create	/admin/{controller-name}/create
edit	admin_crud_{controller_name}_edit	/admin/{controller-name}/edit/{entityId}
delete	admin_crud_{controller_name}_delete	/admin/{controller-name}/delete/{entityId}

Methods¶

Crud Controller provides several methods that allow you to customize the behavior of the controller. These methods can be overridden to customize the controller behavior:

configure(CrudConfig $config): void¶

Configure general behavior of the controller. Customizable options are available here.

protected function configure(CrudConfig $config): void
{
    $config
        ->setTitle(ActionType::LIST, t('All products'))
        ->setMenuTitle(t('Products management'))
        ->setMenuSection('products');
}

configureActions(ActionsConfig $actions): void¶

Configure actions for different page types. See Actions for more details.

protected function configureActions(ActionsConfig $actions): void
{
    $actions->add(
        ActionType::LIST,
        Action::create('export', t('Export'))
            ->linkToRoute('admin_product_export')
    );
}

configureDatagrid(Datagrid $datagrid): void¶

Configure the datagrid for the list page. See Configuring List Page for examples.

protected function configureDatagrid(Datagrid $datagrid): void
{
    $datagrid
        ->add('number', [
            'label' => t('Order Nr.'),
        ])
        ->add('createdAt', [
            'label' => t('Created at'),
        ])
        ->add('domainId', [
            'label' => t('Domain ID'),
        ])
    ;
}

configureQuery(QueryBuilder $queryBuilder): void¶

Modify the query used to fetch entities for the list page.

protected function configureQuery(QueryBuilder $queryBuilder): void
{
    $queryBuilder
        ->andWhere('o.deleted = :deleted')
        ->setParameter('deleted', false);
}

CRUD Config¶

The CrudConfig class is used to configure the behavior of the Crud Controller. It is used in the configure method of the Crud Controller.

Default titles¶

Page titles and the menu label are generated automatically from the entity class name using English singular/plural inflection. For example, entity OrderItem produces menu title "Order items", etc.

These generated names are registered as translation keys automatically — no manual t() wrapping is needed for defaults.

Methods¶

setTitle(ActionType $actionType, string $title)¶

Sets a custom title for a specific page type. The title is displayed in the page header. Overrides the auto-generated default for the given action.

$config->setTitle(ActionType::LIST, t('All orders'));
$config->setTitle(ActionType::CREATE, t('New order'));

setMenuTitle(string $menuTitle)¶

Sets a custom title for the menu item. By default, the pluralized entity name is used (e.g. "Orders" for Order entity).

$config->setMenuTitle(t('Orders management'));

enableAction(ActionType|array $actions) and disableAction(ActionType|array $actions)¶

Those methods are used to enable or disable actions for the given entity.

If you want for example to disable the delete action you can simply call $config->disableAction(ActionType::DELETE).

disable(bool $disabled)¶

Fully disable the CRUD Controller that will not be accessible by the user.

setCustomRoleConstant(?string $roleConstant)¶

Role constant is generated automatically from the controller name by default. If you want to use a custom role constant for permission checking, you can set it using this method.

See Admin Rights and Access Control

setCustomRoleSection(string $roleSection)¶

By default, Menu section is used as role section. If you want to use a custom role section, you can set it using this method.

Role sections can be found in the Shopsys\AdministrationBundle\Component\Security\Role\AdminRoleSectionsProvider class.

setRoutePrefix(string $routePrefix)¶

Set a prefix for the CRUD Controller routes. The prefix is added to the base URL of the CRUD Controller.

Example:

// ProductsController

    protected function configure(CrudConfig $config): void
    {
        $config
            ->setRoutePrefix('/new/')
        ;
    }

The URL for the list action will be /admin/new/products/ instead of /admin/products/.

visibleInMenu(bool $visible)¶

Specify if the CRUD Controller should be visible or not in the administration menu. This can be useful if you want to create a controller that is not directly accessible by the user or should be accessed from another controller.

setMenuSection(string $menuSection, ?string $submenuSection = null)¶

You can specify where the Crud Controller will be displayed in the administration menu.

$menuSection is the name of the root-level menu item. $submenuSection can be used to specify a submenu item.

Examples: - $config->setMenuSection('products') will create Crud controller item under Products section - $config->setMenuSection('customers', 'promo_codes') will create Crud controller under Customers -> Promo Codes section

setMenuIcon(string $icon)¶

Set an icon for the root-level CRUD menu item created by this controller. The icon is only applied when the controller is placed directly under the menu root (i.e. when menuSection is the root). Icons are not used for CRUD items in nested menu sections.

Example:

$config
    ->setMenuIcon('cart')
;