magento事件(event)的dispatchEvent(分发)和catchEvent(获取)

时间:2023-03-09 14:37:32
magento事件(event)的dispatchEvent(分发)和catchEvent(获取)

当你需要扩展Magento的核心的功能时有两个选择:

(1)重写(override)Magento的core classes

(2)使用Magento的event-driven 机制

由于你只能重写一次Magento的core classes(如果你需要在多个module中重写相同core class就会出现错误),所以使用Magento的Event就大显神威了,它使得你的工作简易方便。

Magento的event-driven机制中有两个非常重要的概念:

(1)分发(dispatch)一个事件(event)

(2)捕捉(catch)一个事件(event)

Dispatching events

Magento中你需要调用 Mage::dispatchEvent(...) 就可以Dispatch一个Event, 例:

Mage::dispatchEvent('custom_event', array('object'=>$this));

该方法有两个参数,一个是事件的标识符(在所有事件中唯一)和一个关联数组。该数组的键值是一个data(Varien_Event_Observer 的一个实例),这个data将被执行事件的函数(即observer)进行处理并返回结果。

Catching events

捕捉事件比分发复杂一些,你必须使用一个已有的module或者新建一个module.这里新建一个,目录结构如下:

在该目录的config.xml文件中,我们新定义一个event observer,下面是参考示例(当然你可以定义不同scope的event observer):

magento事件(event)的dispatchEvent(分发)和catchEvent(获取)

上面的xml的配置有一个要注意的地方,就是<type />标签里的值可以是model,object,singleton,其中model和object是等效的且它们都将使用Mage::getModel(....)方法来进行初始化;而singleton将使用Mage::getSingleton(....)来初始化。此外,在Observer.php中就是相关的observer类的定义,该类既不需要继承其他类也不需要继承其他接口。这需要在customObserverAction方法的参数中传入Varien_Event_Observer类的一个实例,正是这个实例对象把dispatcher和event handler联系到一起。同时该实例对象也是继承于Varient_Object,所以拥有getter魔术方法,例:

magento事件(event)的dispatchEvent(分发)和catchEvent(获取)