Aprendiendo a crear Observers en Magento 2

Es una archivo XML de configuración, si recordamos en artículos previos todos los archivos XML que se agregan a módulos de Magento se refieren a configuraciones que necesitan definirse con ciertos criterios para ya sea agregar en tiempo de ejecución configuraciones al backend de Magento o bien configuraciones para sobrescribir clases, así como instancia dores de clase que están a la expectativa de eventos para que puedan ser ejecutados como es el caso de los Observers de Magento, este archivo de configuración lo que permitirá es generar un registro de un Escucha que es indicara que cuando un Disparador de una acción ya sea nativa o personalizada se ejecute este pueda ser invocado para ejecutar una clase como tal que podrá realizar cambios ya sea antes de una acción, después de esa acción, al actualizar la acción y demás instrucciones que le permitirán ejecutar código intermedio cuando estos son agregados en módulos personalizados.

Para este ejercicio no usaremos un módulo real solo indicare donde va cada archivo y al final compartiré el código del ejemplo en un módulo básico para poder ver su ejecución.

Vamos a realizar dos ejemplos de Obervers en Magento 2 para que pueda quedar claro de ambos lados, por un lado los eventos nativos de Magento que podamos detectar y por el otro un evento personalizado que podamos registrar para que de igual forma podamos detectarlo.

Primero lo que realizaremos es un Observer para cachar el evento que se aplica justo antes de agregar un producto al carrito de compras en nuestra tienda de Magento, una vez cachemos el evento ejecutaremos nuestras acciones personalizadas y validaremos si el numero de productos agregados al carrito suman 5 sin importar su tipo ni categoría solo saber cuantos son, así al tratar de agregar un sexto producto nos debe mostrar un mensaje que indique que el numero máximo de productos es de 5 por cliente así que deberá continuar con el flujo si poder agregar mas productos.

Suponiendo que tenemos un módulo llamado Observador dentro de la carpeta de nuestra empresa Marcgento, el archivo events.xml debemos crearlo en esta ruta:  app/code/Macrgento/Observador/etc/frontend/events.xml como podemos ver este archivo debe existir dentro de la carpeta etc/frontend del proyecto como ya lo hemos comentado, que por orden y lugar de ejecución este oyente Observer estará al pendiente de una petición que realizara el cliente en la vista de la tienda y contendrá este contenido:

Aquí podrás encontrar el listado de eventos nativos de Magento 2 para que revises cuál de ellos es el que necesitas conectar tus acciones personalizadas.

Vamos a desarrollar la clase que se ha especificado en el archivo events.xml ya creado lo primero es en donde debemos crear esa clase cual es su objetivo y acciones finales.

Como se pudo observar en el archivo XML en el parámetro instance indica en que parte debemos crear la clase llamada ValidaTotalProductos.php.

Continuando con el ejercicio del ejemplo, en el que contemos con un modulo básico vamos a definir donde debería crearse la clase necesaria.

• Ruta de creación: Marcgento/Observador/Observer/ValidaTotalProductos.php
• Metodo de ejecución: execute

Como podrás darte cuenta y siguiendo las definiciones de Magento vemos como se ha creado la carpeta Observer dentro de la estructura del modulo básico, esto es una sugerencia que nos indica Magento que dentro de esa carpeta irán todos nuestros Observer, son simplemente clases indicadas en los archivos de configuración XML del parámetro instance.

Vamos a crear la clase que se ejecutara una vez se active el evento “checkout_cart_product_add_after” definido en el archivo de configuración XML lo que sucederá es que cada que se agrega un producto al carrito de compras se dispara este evento nativo de Magento se valida que existe un registro de configuración en el modulo Observador y se manda a llamar la clase validaTotalProductos.php que se encuentra en la ruta app/code/Marcgento/Observador/Observer el contenido es el siguiente:

_logger = $logger;
        $this->_session = $session;
    }

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $quote = $this->_session->getQuote();
        $qty =  $quote->getItemsSummaryQty();
        if($qty>=6){
            throw new \Magento\Framework\Exception\NoSuchEntityException(__('Ya no puedes agregar mas productos solo podemos venderte 5 por cliente'));
        }

    }
}

Una vez integrado el modulo personalizado dentro de la tiende y agregando una sección de Observer podemos ver como se aplica la acción justamente después de ejecutar la acción de agregar un producto al carrito de compras se ejecuta el script que valida si la cantidad de productos agregados son igual a 5 no le permitirá agregar más productos y le mostrara el mensaje nativo de Magento mostrando el mensaje como se puede ver en la pantalla de resultado:

El vídeo muestra claramente cómo crear el modulo básico Observador y dentro la estructura que necesita un Observer de Magento 2, espero te sea de ayuda y no olvides dejarme un comentario ya que es la única forma de saber tu opinión buena o mala todo me ha ayudado a ser mejor en mi aprendizaje personal.