Adicionando uma classe ao corpo da página – Magento 2

Se você precisar adicionar programaticamente uma classe à tag body de suas lojas Magento, precisará configurar um observador de eventos para o evento layout_load_before.

Dentro do seu observador, você desejará adicionar o Magento \ Framework \ View \ Page \ Config como dependência.

Em seguida, use o método addBodyClass para adicionar sua classe.

Veja abaixo um exemplo mais detalhado.

No meu exemplo, estou adicionando a turma de login do cliente ao corpo quando um cliente está conectado.

Evento: layout_load_before

Arquivo: etc/frontend/events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="layout_load_before">
        <observer name="vendor_module_add_body_class" instance="Vendor\Module\Observer\AddClassToBody" />
    </event>
</config>

Arquivo: Observer/AddClassToBody.php

<?php
namespace Vendor\Module\Observer;

use Magento\Customer\Model\Session as CustomerSession;
use Magento\Framework\View\Page\Config as PageConfig;
use Magento\Framework\Event\ObserverInterface;

class AddClassToBody implements ObserverInterface
{
    /** @var PageConfig */    protected $pageConfig;
   /** @var CustomerSession */    protected $customerSession;

    public function __construct(PageConfig $pageConfig, CustomerSession $customerSession)
    {
        $this->pageConfig = $pageConfig;
        $this->customerSession = $customerSession;
    }

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        if (!$this->customerSession->isLoggedIn()) {
            return;
        }

        $this->pageConfig->addBodyClass('customer-logged-in');
    }
}

Dica: Alguns nomes de classe no Magento não ajudam muito quando você usa use statement. Usarei frequentemente um alias para se referir às classe, veja abaixo:

Use statement ou Caminho da classe

Não há razão técnica para preferir um sobre o outro, exceto se houver conflitos de nome (como classes diferentes de “Contexto”). Mas isso pode ser resolvido com aliases e é o que eu costumo fazer:

use Magento \ Framework \ Model \ Context como ModelContext;
Eu suponho que no núcleo muitos métodos, especialmente os construtores, foram gerados por ferramentas como a ferramenta de conversão em primeiro lugar e depois não foram alterados para usar as importações “use”.

Então eu sugiro que em seu próprio código você sempre importe classes com “use” para tornar o código real menos detalhado e mais legível.

Exemplo:

Usar diretamente a classe Magento \ Customer \ Model \ Session no meu construtor é longo. Mas também, ao usar use statement, simplesmente colocar Sessão não significa muito.

Em vez disso, farei isso: use Magento \ Customer \ Model \ Session as CustomerSession ;. Imediatamente, fica claro o que a classe está fazendo.

Outro exemplo: use Magento \ Framework \ View \ Page \ Config as PageConfig ;. O Config não significa nada útil, no entanto, o PageConfig é muito mais significativo, pois fornece um pouco mais de contexto para o que a classe faz.