{"id":2892,"date":"2021-01-13T21:05:01","date_gmt":"2021-01-14T00:05:01","guid":{"rendered":"https:\/\/www.magenteiro.com\/blog\/?p=2892"},"modified":"2024-09-16T22:32:44","modified_gmt":"2024-09-17T01:32:44","slug":"criar-evento-personalizado","status":"publish","type":"post","link":"https:\/\/www.magenteiro.com\/blog\/magento-2\/criar-evento-personalizado\/","title":{"rendered":"Crie seu pr\u00f3prio evento no Magento 2"},"content":{"rendered":"\n

Events<\/em> e Observers<\/em> fazem parte do Magento desde suas primeiras vers\u00f5es. O Magento possu\u00ed v\u00e1rios eventos que, ao serem disparados, buscam m\u00f3dulos que acoplaram pontos de observa\u00e7\u00e3o e executam determinada a\u00e7\u00e3o. Eventos s\u00e3o disparados na finaliza\u00e7\u00e3o de um pedido, na emiss\u00e3o de uma fatura, no cadastro de um novo cliente, e em uma centena de outras ocasi\u00f5es.<\/p>\n\n\n\n

Os eventos tamb\u00e9m permitem que estes observadores alterem o comportamento de determinadas funcionalidades no Magento.<\/p>\n\n\n\n

Com a chegada do Magento 2, tamb\u00e9m temos os Plugins, que nos d\u00e3o ainda mais flexibilidade, podendo escutar qualquer m\u00e9todo do Magento, mesmo que nenhum evento seja disparado. Mas hoje focaremos nos Eventos e Observadores. Saiba mais sobre Plugins no meu curso Magento<\/a>.<\/p>\n\n\n\n

Criando um evento personalizado no Magento 2<\/h2>\n\n\n\n

A cria\u00e7\u00e3o de um novo evento \u00e9 um processo bem simples. Tudo que precisamos fazer \u00e9 chamar o m\u00e9todo dispatch da classe \\Magento\\Framework\\Event\\ManagerInterface com um nome do nosso evento. Preferencialmente, um nome \u00fanico.<\/p>\n\n\n\n

Ficaria mais ou menos assim:<\/p>\n\n\n\n

namespace Magenteiro\\Modulo;\n\nclass MinhaClasse\n{\n  \/**\n   * @var \\Magento\\Framework\\Event\\ManagerInterface\n   *\/\n  private $eventManager;\n\n  \/*\n   * @param \\Magento\\Framework\\Event\\ManagerInterface EventManager\n   *\/\n  public function __construct(\\Magento\\Framework\\Event\\ManagerInterface $eventManager)\n  {\n    $this->eventManager = $eventManager;\n  }\n\n  public function enviaPedidoERP()\n  {\n    $pedidoErp = null;\n    \/\/ disparamos um evento no come\u00e7o por exemplo...\n    $this->eventManager->dispatch('pedido_enviado_erp_inicio');\n    \/\/ Integramos com o erp, e obtemos o retorno, salvamos em $pedidoErp...etc\n    $this->eventManager->dispatch('pedido_gravado_erp', ['erpId' => $pedidoErp]);\n  }\n}\n\n<\/pre>\n\n\n\n
No exemplo acima podemos ver que criamos dois eventos distintos: pedido_enviado_erp_inicio<\/code> e pedido_gravado_erp<\/code>.<\/p>\n\n\n\n
Uma vez que os eventos forem criados, qualquer m\u00f3dulo pode escutar estes eventos com o uso de observers<\/a>. O nome do evento \u00e9 passado no atributo name<\/code> dentro do arquivo events.xml<\/code>, como mostrado neste artigo.<\/p>\n\n\n\n
Modificando dados com observers<\/h2>\n\n\n\n
No segundo exemplo criamos um observer<\/em> que passa a vari\u00e1vel $pedidoErp<\/code> no atributo erpId<\/code> para qualquer observer<\/em> que escutar este evento. Esta vari\u00e1vel pode ser de praticamente qualquer tipo, e ser\u00e1 resgatada dentro do observer com $observer->getData('erpId')<\/code>.<\/p>\n\n\n\n
No entanto, se quisermos ter a possibilidade de modificar este valor dentro de um dos Observers<\/em>, temos que passar uma inst\u00e2ncia de \\Magento\\Framework\\DataObject<\/code> no dispatch<\/code>. <\/p>\n\n\n\n
Veja como ficaria o disparo do evento e como modificamos o valor da vari\u00e1vel dentro do observer<\/em>.<\/p>\n\n\n\n
$erpRetorno = new \\Magento\\Framework\\DataObject(['erpId'=>1]);\necho $erpRetorno->getData('erpId'); \/\/resultado: 1\n$this->eventManager->dispatch('pedido_gravado_erp', ['erpRetorno'=>$erpRetorno]);\necho $erpRetorno->getData('erpId'); \/\/resultado: 2<\/pre>\n\n\n\n
public function execute(\\Magento\\Framework\\Event\\Observer $observer)\n{\n    $erpRetorno = $observer->getData('erpRetorno');\n\n    $erpRetorno->setData('erpId', 2);\n    return $this;\n\n}<\/pre>\n\n\n\n
👆Clique nas abas para alternar entre os exemplos.<\/p>\n\n\n\n
Boas pr\u00e1ticas e considera\u00e7\u00f5es<\/h2>\n\n\n\n
No Magento 1 era comum modificarmos valores e comportamentos com o uso de Observers<\/a>. No Magento 2, temos os Plugins para nos ajudar nesta tarefa. Falando nisso, h\u00e1 algum tempo era recomendado que n\u00e3o us\u00e1ssemos Observers no Magento 2 para estes fins.<\/p>\n\n\n\n
Bom, parece que isso vem mudando e n\u00e3o encontrei mais refer\u00eancias sobre essa limita\u00e7\u00e3o. Inclusive at\u00e9 mencionei isso no Magento 2: O Curso<\/a>.<\/p>\n\n\n\n
Eis algumas recomenda\u00e7\u00f5es que ainda s\u00e3o v\u00e1lidas:<\/p>\n\n\n\n