Aprendiendo a crear un Evento propio en Magento 2

Esta es una publicación de continuidad a partir del curso Aprendiendo a crear Observers en Magento 2 si aún no lo has revisado te invito a que primero los revises para que al continuar con esta publicación puedas entender claramente de lo que estaremos hablando durante esta pequeña publicación.

A estas alturas ya sabemos crear un módulo básico en Magento 2 que nos servirá de base para crear un Observer que pueda cachar un evento de la gran lista de eventos que nos proporciona Magento para cachar justo el momento exacto en el que se dispara el evento y poder realizar acciones personalizadas así como se pudo ver en el curso anterior en el ejemplo de cachar el evento “checkout_cart_product_add_after” antes de asignarlo al carrito de compras para poder validar una cantidad que realmente viendo la realidad es algo irreal valga la redundancia ya que en una tienda real no estaríamos colocando este tipo de acciones ya que de lo que se trata en un ecommerce es vender el mayor número de productos, pero para el ejemplo y entendimiento se aplicó de tal forma que se entendiera lo mejor posible.

Pasando ya a lo que nos interesa del tema de crear un Evento propio, antes que nada voy a mencionar un ejemplo para que pueda entenderse de forma clara lo que trato de expresar cuando hablamos de crear un evento propio, me refiero a registrar un evento que no existan aun en el gran listado de eventos nativos de Magento y por poner un ejemplo voy a crear uno que actual mente no existe y será en la sección de comentarios en el detalle del producto:
Como la mayoría de los que trabajamos con Magento sabemos que ya existe una sección de comentarios en el detalle de un producto siendo más exactos hay un modelos de datos a nivel de tablas llamados review en donde los comentarios que se envían a un producto en particular quedan almacenados en la tabla review_detail, claro cualquier usuario puede dejar un comentario del producto e incluso hasta dar una calificación del mismo:
Lo que quiero es desarrollar un módulo personalizado que dispare un evento justo cuando se agrega un comentario en el detalle de producto, nuestro evento se llamara “add_comment_review_after” y este deberá existir dentro del archivo vendor/magento/module-review/Controller/Product/Post.php pero que pasa aquí estoy refiriéndome a un archivo de una clase nativa de Magento, pues lo que voy a necesitar es sobrescribir la clase nativa y en la nueva referencia agregar justo el código que necesito para lograr cumplir con el objetivo de este curso y es que lo que quiero es cachar el momento exacto en el que se le da clic al botón de Submit Review..

Lo primero que voy a ser es crear un archivo de configuración di.xml que estará ubicado en la carpeta etc y se llamara di.xml el cual contendrá este contenido:

Por ahora no es parte de este curso explicar esta clase cuando pase a crear un curso especial sobre la forma de sobrescribir clases nativas de Magento lo mostrare a detalle por ahora simplemente crearemos un archivo de configuración como se ha indicado.

El contenido de la clase indicada por la instancia del archivo di.xml en el path
Marcgento\Observador\Controller\Product\Post contendrá:

namespace Marcgento\Observador\Controller\Product;

use Magento\Review\Controller\Product as ProductController;
use Magento\Framework\Controller\ResultFactory;
use Magento\Review\Model\Review;

class Post extends ProductController
{
    /**
     * Submit new review action
     *
     * @return \Magento\Framework\Controller\Result\Redirect
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @SuppressWarnings(PHPMD.NPathComplexity)
     */
    public function execute()
    {
        /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
        $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
        if (!$this->formKeyValidator->validate($this->getRequest())) {
            $resultRedirect->setUrl($this->_redirect->getRefererUrl());
            return $resultRedirect;
        }

        $data = $this->reviewSession->getFormData(true);
        if ($data) {
            $rating = [];
            if (isset($data['ratings']) && is_array($data['ratings'])) {
                $rating = $data['ratings'];
            }
        } else {
            $data = $this->getRequest()->getPostValue();
            $rating = $this->getRequest()->getParam('ratings', []);
        }

        if (($product = $this->initProduct()) && !empty($data)) {
            /** @var \Magento\Review\Model\Review $review */
            $review = $this->reviewFactory->create()->setData($data);
            $review->unsetData('review_id');

            $validate = $review->validate();
            if ($validate === true) {
                try {
                    $review->setEntityId($review->getEntityIdByCode(Review::ENTITY_PRODUCT_CODE))
                        ->setEntityPkValue($product->getId())
                        ->setStatusId(Review::STATUS_PENDING)
                        ->setCustomerId($this->customerSession->getCustomerId())
                        ->setStoreId($this->storeManager->getStore()->getId())
                        ->setStores([$this->storeManager->getStore()->getId()])
                        ->save();

                    foreach ($rating as $ratingId => $optionId) {
                        $this->ratingFactory->create()
                            ->setRatingId($ratingId)
                            ->setReviewId($review->getId())
                            ->setCustomerId($this->customerSession->getCustomerId())
                            ->addOptionVote($optionId, $product->getId());
                    }
                    $review->aggregate();

                    $parameters = [
                        'datos' => $data,
                        'review' => $review
                    ];

                    $this->_eventManager->dispatch('add_comment_review_after', $parameters);

                    $this->messageManager->addSuccess(__('You submitted your review for moderation.'));
                } catch (\Exception $e) {
                    $this->reviewSession->setFormData($data);
                    $this->messageManager->addError(__('No se puede mostrar ahora tu calificacion.'));
                }
            } else {
                $this->reviewSession->setFormData($data);
                if (is_array($validate)) {
                    foreach ($validate as $errorMessage) {
                        $this->messageManager->addError($errorMessage);
                    }
                } else {
                    $this->messageManager->addError(__('We can\'t post your review right now.'));
                }
            }
        }
        $redirectUrl = $this->reviewSession->getRedirectUrl(true);
        $resultRedirect->setUrl($redirectUrl ?: $this->_redirect->getRedirectUrl());
        return $resultRedirect;
    }
}

He copiado la clase tal cual pero lo que quiero que vean es una sección de código que se agregó:

     $parameters = [
                      'datos' => $data,
                      'review' => $review
                   ];

      $this->_eventManager->dispatch('add_comment_review_after', $parameters);

Este bloque de código es justo de lo que trata este curso es el registro del nuevo evento “add_comment_review_after” este es su identificador el cual podrá ser llamado desde cualquier componente justo al momento de cuando un cliente añada un comentario al detalle del producto dando al mismo tiempo una calificación.

Ya con lo realizado hasta este momento ya se ha podido ver como se crea un evento propio en Magento, ahora pasaremos a llamar el evento recién creado “add_comment_review_after” desde un módulo personalizado para lo cual usaremos el mismo del curso anterior Aprendiendo a crear Observers en Magento 2

En el mismo modulo Observador dentro de la carpeta de nuestra empresa Marcgento, el archivo events.xml ubicado en la ruta debemos agregar el siguiente código:

El código que se ha agregado al archivo de events.xml ya existente es:

Este es el que indica el llamado ya registrado en la clase sobrescrita anteriormente, recordar que podemos agregar cualquier número de observer en los archivos de configuración events.xml de nuestros componentes personalizados.

Vamos a crear la clase que se ejecutara una vez se active el evento “add_comment_review_after” definido en el archivo de configuración XML lo que sucederá es que cada que se agrega un comentario en el detalle del producto se disparara el Evento propio ya creado y realizara una validación si la calificación es de 5 estrellas en automático el comentario pasara como aprobado, cabe mencionar que de forma predeterminada los comentarios no se publican automáticamente ya que un administrador antes debe validarlos y aprobarlos desde el BackEnd, esto es solo un ejercicio para entender cómo se registra un Evento propio y como se manda a llamar realizando acciones personalizadas, la clase que se instancia se llama AddComment.php que se encuentra en la ruta app/code/Marcgento/Observador/Observer el contenido es el siguiente:

Comentario aprobado en automático:

Los comentarios que no sean aprobados automáticamente se ven reflejados en el backend en la sección MARKETING > User Content > Reviews: