如何在Magento中调试我的事件观察器?

时间:2011-07-14 12:53:30

标签: events magento observer-pattern

我的观察员没有被召唤。我想知道如何调度事件以便我可以调试它。

2 个答案:

答案 0 :(得分:9)

这是Magento的Mage_Core_Model_App :: dispatchEvent()调用的细分,它是用于触发事件的。我的评论将在我所描述的代码插入之前。我会遗漏明显的东西。值得一提的是,这是从Magento Enterprise 1.10.1.1的角度出发的。

首先,这是整个方法定义:

public function dispatchEvent($eventName, $args)
{
    foreach ($this->_events as $area=>$events) {
        if (!isset($events[$eventName])) {
            $eventConfig = $this->getConfig()->getEventConfig($area, $eventName);
            if (!$eventConfig) {
                $this->_events[$area][$eventName] = false;
                continue;
            }
            $observers = array();
            foreach ($eventConfig->observers->children() as $obsName=>$obsConfig) {
                $observers[$obsName] = array(
                    'type'  => (string)$obsConfig->type,
                    'model' => $obsConfig->class ? (string)$obsConfig->class : $obsConfig->getClassName(),
                    'method'=> (string)$obsConfig->method,
                    'args'  => (array)$obsConfig->args,
                );
            }
            $events[$eventName]['observers'] = $observers;
            $this->_events[$area][$eventName]['observers'] = $observers;
        }
        if (false===$events[$eventName]) {
            continue;
        } else {
            $event = new Varien_Event($args);
            $event->setName($eventName);
            $observer = new Varien_Event_Observer();
        }

        foreach ($events[$eventName]['observers'] as $obsName=>$obs) {
            $observer->setData(array('event'=>$event));
            Varien_Profiler::start('OBSERVER: '.$obsName);
            switch ($obs['type']) {
                case 'disabled':
                    break;
                case 'object': case 'model':
                    $method = $obs['method'];
                    $observer->addData($args);
                    $object = Mage::getModel($obs['model']);
                    $this->_callObserverMethod($object, $method, $observer);
                    break;
                default:
                    $method = $obs['method'];
                    $observer->addData($args);
                    $object = Mage::getSingleton($obs['model']);
                    $this->_callObserverMethod($object, $method, $observer);
                    break;
            }
            Varien_Profiler::stop('OBSERVER: '.$obsName);
        }
    }
    return $this;
}

我们从宣言开始。触发了特定名称的事件,以及一些可选的支持数据以及它。

public function dispatchEvent($eventName, $args)
{

虽然某些事件具有简单的名称,但与控制器相关的predispatch和postdispatch事件之类的事件不仅会发出一般事件,还会发出特定于控制器的事件。暂时,看看Mage_Core_Controller_Varien_Action中的preDispatch方法:

    Mage::dispatchEvent('controller_action_predispatch', array('controller_action'=>$this));
    Mage::dispatchEvent(
        'controller_action_predispatch_'.$this->getRequest()->getRouteName(),
        array('controller_action'=>$this)
    );
    Mage::dispatchEvent(
        'controller_action_predispatch_'.$this->getFullActionName(),
        array('controller_action'=>$this)

同时发出三个不同的事件,您可以在其中任何一个上配置观察者。

接下来,我们循环查看观察者已注册的事件区域和事件。事件区域可以是“前端”或“全局”,但这是一个您不应该关注的内部概念。

    foreach ($this->_events as $area=>$events) {
        if (!isset($events[$eventName])) {

获取此事件的派生配置。这本质上是一个XML节点,包含通过配置为此事件定义的所有观察者。除非为此事件定义了至少一个观察者,否则不会找到任何配置。在这种情况下,我们将$ this-> _events [$ area] [$ eventName]设置为FALSE,我们将来会通过上述条件绕过此检查。

            $eventConfig = $this->getConfig()->getEventConfig($area, $eventName);
            if (!$eventConfig) {
                $this->_events[$area][$eventName] = false;
                continue;
            }

构建一个注册观察者数组。

            $observers = array();
            foreach ($eventConfig->observers->children() as $obsName=>$obsConfig) {
                $observers[$obsName] = array(
                    'type'  => (string)$obsConfig->type,
                    'model' => $obsConfig->class ? (string)$obsConfig->class : $obsConfig->getClassName(),
                    'method'=> (string)$obsConfig->method,
                    'args'  => (array)$obsConfig->args,
                );
            }
            $events[$eventName]['observers'] = $observers;
            $this->_events[$area][$eventName]['observers'] = $observers;
        }

如果在此传球或之前的传球中没有找到观察者,则循环。

        if (false===$events[$eventName]) {
            continue;

否则,准备触发观察员。我们构建了一个Varien_Event作为事件的一个非常简单的容器,以及一个进一步包装它的Varien_Event_Observer。这是作为参数发送给观察者的。

        } else {
            $event = new Varien_Event($args);
            $event->setName($eventName);
            $observer = new Varien_Event_Observer();
        }

现在,循环观察者。对于每个观察者,根据其定义的类型(“model”,singleton“等)实例化观察者的对象。然后,调用_callObserverMethod,这样可以确保在调用该对象之前该方法存在。注意类型的观察者“singleton”属于下面的“默认”案例。

        foreach ($events[$eventName]['observers'] as $obsName=>$obs) {
            $observer->setData(array('event'=>$event));
            Varien_Profiler::start('OBSERVER: '.$obsName);
            switch ($obs['type']) {
                case 'disabled':
                    break;
                case 'object': case 'model':
                    $method = $obs['method'];
                    $observer->addData($args);
                    $object = Mage::getModel($obs['model']);
                    $this->_callObserverMethod($object, $method, $observer);
                    break;
                default:
                    $method = $obs['method'];
                    $observer->addData($args);
                    $object = Mage::getSingleton($obs['model']);
                    $this->_callObserverMethod($object, $method, $observer);
                    break;
            }
            Varien_Profiler::stop('OBSERVER: '.$obsName);
        }
    }
    return $this;
}

答案 1 :(得分:3)

所有事件都通过Mage::dispatchEvent()。只需grep或ack代表“dispatchEvent”或您感兴趣的事件名称,您就会看到它的调用位置。在该行放置一个断点。