Elemento personalizado en menú lateral de SonataAdmin

Escenario

Necesito añadir un enlace a una página personalizada en el menú lateral de Sonata Admin. En concreto uno que, en vez de dirigir a un listado de entidades, abra una página específica. La entidad en cuestión es Acme\Entity\CashOffice. Antes que nada tenemos que crear un CashOfficeAdmin en el cual usaremos el método configureRoutes para añadir la nueva ruta a la acción del controlador que devuelve nuestra página, y suprimir la ruta list:

    /**
     *
     * @param RouteCollection $collection
     */
    public function configureRoutes(RouteCollection $collection)
    {
        $collection
                ->add('list', 'index', array(
                    '_controller' => 'Acme\Controller\CashOfficeAdminController:index',
                    'methods' => array('GET'))
        );
        $collection->remove('list');
    }

/**

* @param RouteCollection $collection

public function configureRoutes(RouteCollection $collection)

{

$collection

->add('list', 'index', array(

'_controller' => 'Acme\Controller\CashOfficeAdminController:index',

'methods' => array('GET'))

);

$collection->remove('list');

}

Creamos el controlador…

<?php

// src/Controller/CashOfficeAdminController

namespace Acme\Controller;

use Acme\Manager\CashOfficeManager;

use Sonata\AdminBundle\Controller\CRUDController;

use Symfony\Component\HttpFoundation\Response;

/**
 *
 * @author Marcos
 */
class CashOfficeAdminController extends CRUDController
{
    public function index(): Response
    {
        $cashOfficeManager = $this->admin->getModelManager();

        return $this->render('CashOfficeAdmin/index.html.twig', array(
                    'action' => 'index',
                    'cashOffice' => $cashOfficeManager->getParkingMainCashOffice()
        ));
    }
}

<?php

// src/Controller/CashOfficeAdminController

namespace Acme\Controller;

use Acme\Manager\CashOfficeManager;

use Sonata\AdminBundle\Controller\CRUDController;

use Symfony\Component\HttpFoundation\Response;

/**

* @author Marcos

class CashOfficeAdminController extends CRUDController

{

public function index(): Response

{

$cashOfficeManager = $this->admin->getModelManager();

return $this->render('CashOfficeAdmin/index.html.twig', array(

'action' => 'index',

'cashOffice' => $cashOfficeManager->getParkingMainCashOffice()

));

}

La vista…

{% extends base_template %}
{%- block actions -%}
    {% include '@SonataAdmin/CRUD/action_buttons.html.twig' %}
{%- endblock -%}
{%- block tab_menu -%}
    {{ knp_menu_render(admin.sidemenu(action), {
        'currentClass': 'active',
        'template': get_global_template('tab_menu_template')
    }, 'twig') }}
{%- endblock -%}
{% block title %}
    {{ "cashOffice"|trans }}
{% endblock %}
{% block navbar_title %}
    {{ block('title') }}
{% endblock %}
{% block stylesheets %}
    {{ parent() }}
{% endblock stylesheets %}
{% block sonata_admin_content %}
    <h2>
        {{ "cash_balance"|trans }}: <strong class="text-{{ (cashOffice.getBalance() < 0) ? 'danger' : 'success' }}">{{ cashOffice.getBalance() }} € </strong>
    </h2>
{% endblock sonata_admin_content %}

{% extends base_template %}

{%- block actions -%}

{% include '@SonataAdmin/CRUD/action_buttons.html.twig' %}

{%- endblock -%}

{%- block tab_menu -%}

{{ knp_menu_render(admin.sidemenu(action), {

'currentClass': 'active',

'template': get_global_template('tab_menu_template')

}, 'twig') }}

{%- endblock -%}

{% block title %}

{% endblock %}

{% block navbar_title %}

{% endblock %}

{% block stylesheets %}

{% endblock stylesheets %}

{% block sonata_admin_content %}

<h2>

{{ "cash_balance"|trans }}: <strong class="text-{{ (cashOffice.getBalance() < 0) ? 'danger' : 'success' }}">{{ cashOffice.getBalance() }} € </strong>

</h2>

{% endblock sonata_admin_content %}

el servicio:

    acme.admin.cash_office:
        class: Acme\Admin\CashOfficeAdmin
        arguments: [~, Acme\Entity\CashOffice, Acme\Controller\CashOfficeAdminController]
        tags:
            - { name: sonata.admin, manager_type: orm, label: cash_office, label_catalogue: Acme, label_translator_strategy: sonata.admin.label.strategy.noop }
        calls:
            - [ setModelManager, [ '@acme.manager.cash_office' ]]
        public: true

acme.admin.cash_office:

class: Acme\Admin\CashOfficeAdmin

arguments: [~, Acme\Entity\CashOffice, Acme\Controller\CashOfficeAdminController]

tags:

- { name: sonata.admin, manager_type: orm, label: cash_office, label_catalogue: Acme, label_translator_strategy: sonata.admin.label.strategy.noop }

calls:

- [ setModelManager, [ '@acme.manager.cash_office' ]]

public: true

Y, por último, añadimos el siguiente bloque en config/packages/sonata_admin.yaml:

    dashboard:
        groups:
            cash_office:
                label: cash_office                
                label_catalogue: messages
                icon: '<i class="fa fa-money"></i>'
                items:
                  - admin: acme.admin.cash_office
                    route: admin_acme_cashoffice_index
                    label: 'cash_register'
                roles: [ROLE_SONATA_ADMIN]

dashboard:

groups:

cash_office:

label: cash_office

label_catalogue: messages

icon: '<i class="fa fa-money"></i>'

items:

- admin: acme.admin.cash_office

route: admin_acme_cashoffice_index

label: 'cash_register'

roles: [ROLE_SONATA_ADMIN]

Problema

Después de actualizar a la última versión de Sonata Admin (3.78.1), despareció el menú de CashOffice. Conseguí restaurarlo dando de alta un Listener que capture el evento del menú y modifique el árbol que lo compone. La clase debe contener un método público para construir los elementos:

namespace Acme\EventListener;

use Sonata\AdminBundle\Event\ConfigureMenuEvent;

/**
 * Description of MenuBuilderListener
 *
 * @author marcos
 */
class MenuBuilderListener
{

    /**
     * @param ConfigureMenuEvent $event
     */
    public function adminMenuItems(ConfigureMenuEvent $event)
    {
        $event->getMenu()
                ->addChild('cash_office')
                ->setExtras(
                        [
                            'roles' => ['ROLE_SONATA_ADMIN'],
                            'icon' => '<i class="fa fa-money"></i>'
                        ]
                )
                ->addChild(
                        'cash_register',
                        [
                            'route' => 'admin_acme_cashoffice_index',
                        ]
                )
                ->setLabel('cash_register')
                ->setExtras(
                        [
                            'roles' => ['ROLE_SONATA_ADMIN'],
                        ]
                );
    }

}

namespace Acme\EventListener;

use Sonata\AdminBundle\Event\ConfigureMenuEvent;

/**

* Description of MenuBuilderListener

* @author marcos

class MenuBuilderListener

{

/**

* @param ConfigureMenuEvent $event

public function adminMenuItems(ConfigureMenuEvent $event)

{

$event->getMenu()

->addChild('cash_office')

->setExtras(

[

'roles' => ['ROLE_SONATA_ADMIN'],

'icon' => '<i class="fa fa-money"></i>'

]

)

->addChild(

'cash_register',

[

'route' => 'admin_acme_cashoffice_index',

]

)

->setLabel('cash_register')

->setExtras(

[

'roles' => ['ROLE_SONATA_ADMIN'],

]

);

}

Luego di de alta el siguiente bloque en el services.yaml:

    acme.event_listener.app.admin_menu:
        class: Acme\EventListener\MenuBuilderListener
        tags:
            - { name: kernel.event_listener, event: sonata.admin.event.configure.menu.sidebar, method: adminMenuItems }

acme.event_listener.app.admin_menu:

class: Acme\EventListener\MenuBuilderListener

tags:

- { name: kernel.event_listener, event: sonata.admin.event.configure.menu.sidebar, method: adminMenuItems }

Y, ahora, aunque aparece el enlace en el menú lateral, cuando se carga la página éste no queda activado.

Solución

La solución del Listener no me convence, a parte de que no queda activo el enlace cuando se encuentra en la página que le corresponde, me digo que tiene que haber una manera más sencilla de conseguirlo. Tras investigar el código fuente de Sonata Admin doy con el motivo por el que ya no se muestra el enlace. En vendor/sonata-project/admin-bundle/src/Menu/Provider/GroupMenuProvider.php hay un método que decide si se puede generar el elemento del menú:

    private function canGenerateMenuItem(array $item, array $group): bool
    {
        if (isset($item['admin']) && !empty($item['admin'])) {
            $admin = $this->pool->getInstance($item['admin']);

            // skip menu item if no `list` url is available or user doesn't have the LIST access rights
            return $admin->hasRoute('list') && $admin->hasAccess('list');
        }

        //NEXT_MAJOR: Remove if statement of null checker.
        if (null === $this->checker) {
            return true;
        }

        // Making the checker behave affirmatively even if it's globally unanimous
        // Still must be granted unanimously to group and item

        $isItemGranted = true;
        if (!empty($item['roles'])) {
            $isItemGranted = false;
            foreach ($item['roles'] as $role) {
                if ($this->checker->isGranted($role)) {
                    $isItemGranted = true;
                    break;
                }
            }
        }

        $isGroupGranted = true;
        if (!empty($group['roles'])) {
            $isGroupGranted = false;
            foreach ($group['roles'] as $role) {
                if ($this->checker->isGranted($role)) {
                    $isGroupGranted = true;
                    break;
                }
            }
        }

        return $isItemGranted && $isGroupGranted;
    }

private function canGenerateMenuItem(array $item, array $group): bool

{

if (isset($item['admin']) && !empty($item['admin'])) {

$admin = $this->pool->getInstance($item['admin']);

// skip menu item if no `list` url is available or user doesn't have the LIST access rights

return $admin->hasRoute('list') && $admin->hasAccess('list');

}

//NEXT_MAJOR: Remove if statement of null checker.

if (null === $this->checker) {

return true;

}

// Making the checker behave affirmatively even if it's globally unanimous

// Still must be granted unanimously to group and item

$isItemGranted = true;

if (!empty($item['roles'])) {

$isItemGranted = false;

foreach ($item['roles'] as $role) {

if ($this->checker->isGranted($role)) {

$isItemGranted = true;

break;

}

$isGroupGranted = true;

if (!empty($group['roles'])) {

$isGroupGranted = false;

foreach ($group['roles'] as $role) {

if ($this->checker->isGranted($role)) {

$isGroupGranted = true;

break;

}

return $isItemGranted && $isGroupGranted;

}

Como se puede ver, si el elemento del menú no apunta a una URL de tipo list se deniega la generación del elemento. El método es privado y, de primeras, no veo cómo puedo sobreescribirlo. Decido cambiar de estrategia. En vez de dar de alta una URL para index con la página personlizada, uso la ruta list para que apunte donde yo quiero. Modifico pues el método configureRoutes de la clase Admin:

    /**
     *
     * @param RouteCollection $collection
     */
    public function configureRoutes(RouteCollection $collection)
    {
        $collection->remove('list');
        $collection
                ->add('list', 'index', array(
                    '_controller' => 'Acme\Controller\CashOfficeAdminController:index',
                    'methods' => array('GET'))
        );
    }

/**

* @param RouteCollection $collection

public function configureRoutes(RouteCollection $collection)

{

$collection->remove('list');

$collection

->add('list', 'index', array(

'_controller' => 'Acme\Controller\CashOfficeAdminController:index',

'methods' => array('GET'))

);

}

Como se puede ver, primero elimino la ruta list para luego crearla de nuevo apuntando a donde quiero. Ya no necesito dar de alta el MenuBuilderListener y el bloque del sonata_admin.yaml quedaría así:

            cash_office:
                label: cash_office                
                label_catalogue: messages
                icon: '<i class="fa fa-money"></i>'
                items:
                    - acme.admin.cash_office
                roles: [ROLE_SONATA_ADMIN]

cash_office:

label: cash_office

label_catalogue: messages

icon: '<i class="fa fa-money"></i>'

items:

- acme.admin.cash_office

roles: [ROLE_SONATA_ADMIN]

Nota: Estoy usando la versión de Symfony 4.4 y la 3.78.1 de SonataAdmin.

Elemento personalizado en menú lateral de SonataAdmin

Escenario

Problema

Solución

Cómo recuperar ficheros borrados de Amazon Linux

¿Qué es www.roxoenos.xyz?

Traducción de variables en javascript

Conector Symfony2 Simple Machines Forum

Timeout al actualizar con composer

Preparando los exámenes

Deja una respuesta Cancelar la respuesta

Escenario

Problema

Solución

Publicaciones Similares

Deja una respuesta Cancelar la respuesta