Magento 入门教程 - Magento 中的 Events 和 observers
文章目录
Magento 入门教程之 Magento 中的 Events 和 observer。
这篇Magento入门教程主要介绍 Magento 中的事件和具体的观察者的通用实现。希望通过这篇文档让读者能够快速入门Magento开发。
更详细的教程地址参考《Magento 实战》
定义
Magento 中的 Events 和 observers 是对发布-订阅模式的简洁实现。它可以使我们在特定行为触发时抛出一个事件,在响应触发事件过程中调用我们的自定义代码。事件通过 Magento\Framework\Event\Manager 类来分发。它实现了 Magento\Framework\Event\ManagerInterface 接口。
调用调用事件管理对象(eventManager) 的实例的 dispatch 方法来触发事件。第一个参数是触发的事件名称,第二个参数是可选参数,类型是数组,里面可以包含需要传递给监听者的数据。<MAGENTO_DIR>/module-customer/Controller/Account/CreatePost.php 中的例子如下:
$this->_eventManager->dispatch(
'customer_register_success',
['account_controller' => $this, 'customer' => $customer]
);通过 events.xml 来注册观察者,<MAGENTO_DIR>/module-persistent/etc/frontend/events.xml 中的例子如下:
<event name="customer_register_success">
<observer name="persistent" instance="Magento\Persistent\Observer\RemovePersistentCookieOnRegisterObserver" />
</event>Magento 中比较重要的事件
在<MAGENTO_DIR> 目录下的 PHP 文件中搜索 eventManager->dispatch 能看到很多事件的例子。我们会重点研究以下的类以及相关事件。
Magento\Framework\App\Action\Action 类中包含以下事件
- controller_action_predispatch
- 'controller_action_predispatch_' . $request->getRouteName()
- 'controller_action_predispatch_' . $request->getFullActionName()
- 'controller_action_postdispatch_' . $request->getFullActionName()
- 'controller_action_postdispatch_' . $request->getRouteName()
- controller_action_postdispatch
Magento\Framework\Model\AbstractModel 中包含以下事件
- model_load_before
- $this->_eventPrefix . '_load_before'
- model_load_after
- $this->_eventPrefix . '_load_after'
- model_save_commit_after
- $this->_eventPrefix . '_save_commit_after'
- model_save_before
- $this->_eventPrefix . '_save_before'
- model_save_after
- clean_cache_by_tags
- $this->_eventPrefix . '_save_after'
- model_delete_before
- $this->_eventPrefix . '_delete_before'
- model_delete_after
- clean_cache_by_tags
- $this->_eventPrefix . '_delete_after'
- model_delete_commit_after
- $this->_eventPrefix . '_delete_commit_after'
- $this->_eventPrefix . '_clear'
Magento\Framework\Model\ResourceModel\Db\Collection 类中包含以下事件
- core_collection_abstract_load_before
- $this->_eventPrefix . '_load_before'
- core_collection_abstract_load_after
- $this->_eventPrefix . '_load_after'
另外在 <MAGENTO_DIR>/framework/View 中也有一些比较重要的事件
- view_block_abstract_to_html_before
- view_block_abstract_to_html_after
- view_message_block_render_grouped_html_after
- layout_render_before
- 'layout_render_before_' . $this->request->getFullActionName()
- core_layout_block_create_after
- layout_load_before
- layout_generate_blocks_before
- layout_generate_blocks_after
- core_layout_render_element
具体事件相关实现
下面看看 <MAGENTO_DIR>/framework/Model/AbstractModel.php 类中的一个事件的代码
public function afterCommitCallback() {
$this->_eventManager->dispatch('model_save_commit_after', ['object' => $this]);
$this->_eventManager->dispatch($this->_eventPrefix . '_save_commit_after', $this->_getEventData());
return $this;
}
protected function _getEventData() {
return [
'data_object' => $this,
$this->_eventObject => $this,
];
}这里的 $_eventPrefix 和 $_eventObject 属性在这里十分重要,如果我们看看类似 Magento\Catalog\Model\Product 、Magento\Catalog\Model\Category 、 Magento\Customer\Model\Customer、Magento\Quote\Model\Quote 、Magento\Sales\Model\Order 和其他继承自 Magento\Framework\Model\AbstractModel 的类,都提供了自己的值来覆盖父类的 $_eventPrefix = 'core_abstract' 和 $_eventObject = 'object', 因此我们可以通过 $this->_eventPrefix . '_save_commit_after' 来指定不同的观察者。

评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论