EasyCorp
Allow dynamic CRUD controllers linkage to Dashboard controllers
With pretty URLs, it is now possible to easily have multiple dashboard controllers. But the issue is that under the hood, EA tries to apply ALL CRUD controllers to ALL Dashboards when generating URLs. For example, if we have AdminDashboard and CustomerDashboard controllers in different namespaces, EA will link ALL available CRUDs to both dashboards making customer CRUDs available for admins and admin CRUDs available customers!
final class AdminRouteGenerator implements AdminRouteGeneratorInterface
{
...
private function generateAdminRoutes(): array
{
...
foreach ($this->dashboardControllers as $dashboardController) {
...
foreach ($this->crudControllers as $crudController) {
...
$adminRoutes[$adminRouteName] = $adminRoute;
...
}
...
}
}
}
The suggestion is to implement a basic dynamic CRUD controllers filtering. I'm using the following patch:
--- a/src/Router/AdminRouteGenerator.php
+++ b/src/Router/AdminRouteGenerator.php
@@ -131,6 +131,9 @@
// then, create the routes of the CRUD controllers associated with the dashboard
foreach ($this->crudControllers as $crudController) {
$crudControllerFqcn = $crudController::class;
+ if (method_exists($dashboardController, 'isCrudControllerAllowed') && !$dashboardController::isCrudControllerAllowed($crudControllerFqcn)) {
+ continue;
+ }
if (null !== $allowedCrudControllers && !\in_array($crudControllerFqcn, $allowedCrudControllers, true)) {
continue;
It adds the support of the isCrudControllerAllowed method to dashboard controllers so I can do the following filtering:
namespace App\Controller\Admin; // All Admin controllers are in this namespace
class DashboardController extends AbstractDashboardController
{
/**
* Allow only CRUD controllers from the current namespace.
*/
public static function isCrudControllerAllowed(string $controllerFqcn): bool
{
return str_starts_with($controllerFqcn, __NAMESPACE__ . '\\');
}
}
Which easily and effectively removes all useless CRUD controllers from the dashboard routes.
The current method of removing CRUDs by adding them to the AdminDashboard attribute is inconvenient in this case because we have many CRUD controllers and manual list management is hard and ineffective - someone may forget to add an exclusion without any errors/warnings/hints potentially exposing unneeded functionality to users that should not have access to.
The above is an example of the idea implementation and it can be implemented in many ways. It's up to the authors to choose one.
I could imagine another option like this:
namespace App\Controller\Admin;
#[AdminDashboard('/admin/dashboard', 'admin_dashboard', crudFilterTag: 'admin')]
class DashboardController extends AbstractDashboardController
And then in the Symfony config:
App\Controller\Admin\:
resource: '../src/Controller/Admin/'
tags:
- 'controller.service_arguments'
- name: 'ea.crud_filter', value: 'admin'
App\Controller\Customer\:
resource: '../src/Controller/Customer/'
tags:
- 'controller.service_arguments'
- name: 'ea.crud_filter', value: 'customer'
This way, all controllers in these two namespaces will have the corresponding ea.crud_filter tag value so AdminRouteGenerator will match it to the AdminDashboard::$crudFilterTag value and decide whether to add the CRUD to the dashboard or not.
@ben29 It'll be a breaking change, so I would prefer to let maintainers decide.