magento - 除模块覆盖外，还会出现覆盖块

Question

Magento 1.4.1.1

回溯历史，app/code/core/Mage/GoogleAnalytics/Block/Ga.php被复制到app/code/local/Mage/GoogleAnalytics/Block/Ga.php并进行了更改，以便该protected function _toHtml() {}函数可以生成正确的 Google页面上的分析异步 javascript 条目。原版存在未针对该网站正确向 Google 发布跟踪信息的问题。此重写功能完全正常，并获得了预期的结果。

为了清理，决定将此更改模块化为本地命名空间模块。创建了以下文件...

应用程序/etc/modules/Chief_GoogleAnalytics.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Chief_GoogleAnalytics>
            <active>true</active>
            <codePool>local</codePool>
        </Chief_GoogleAnalytics>
    </modules>
</config>

应用程序/代码/本地/Chief/GoogleAnalytics/etc/config.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Chief_GoogleAnalytics>
            <version>0.1.0</version>
        </Chief_GoogleAnalytics>
    </modules>
    <global>
        <blocks>
            <googleanalytics>
                <rewrite>
                    <ga>Chief_GoogleAnalytics_Block_Ga</ga>
                </rewrite>
            </googleanalytics>
        </blocks>
    </global>
</config>

app/code/local/Chief/GoogleAnalytics/Block/Ga.php

/**
 * GoogleAnalitics Page Block
 *
 * @category   Chief
 * @package    Chief_GoogleAnalytics
 * @author     Magento Core Team <core@magentocommerce.com>
 */
class Chief_GoogleAnalytics_Block_Ga extends Mage_GoogleAnalytics_Block_Ga
{
    /**
     * Prepare and return block's html output
     *
     * @return string
     */
    protected function _toHtml()
    {
        if (!Mage::getStoreConfigFlag('google/analytics/active')) {
            return '';
        }

        $this->addText('
<!-- BEGIN GOOGLE ANALYTICS CODE -->
<script type="text/javascript">
//<![CDATA[
    var _gaq = _gaq || [];
    _gaq.push(["_setAccount", "' . $this->getAccount() . '"]);
    _gaq.push(["_trackPageview", "'.$this->getPageName().'"]);

    (function() {
        var ga = document.createElement(\'script\'); ga.type = \'text/javascript\'; ga.async = true;
        ga.src = (\'https:\' == document.location.protocol ? \'https://ssl\' : \'http://www\') + \'.google-analytics.com/ga.js\';
        var s = document.getElementsByTagName(\'script\')[0]; s.parentNode.insertBefore(ga, s);
    })();
//]]>
</script>
<!-- END GOOGLE ANALYTICS CODE -->
        ');

        $this->addText($this->getQuoteOrdersHtml());

        if ($this->getGoogleCheckout()) {
            $protocol = Mage::app()->getStore()->isCurrentlySecure() ? 'https' : 'http';
            $this->addText('<script src="'.$protocol.'://checkout.google.com/files/digital/ga_post.js" type="text/javascript"></script>');
        }

        return parent::_toHtml();
    }
}

当它来自app/code/local/Mage/GoogleAnalytics/Block/Ga.php时，而不是正常的单个更正脚本条目，我现在得到一个重复。Chief_GoogleAnalytics Block 覆盖首先出现，然后是来自app/code/core/Mage/GoogleAnalytics/Block/Ga.php的旧股票垃圾代码。Google Analytics 有一个布局 XML 文件，将其定义为在after_body_start中显示，这样就可以了。这是显示新块覆盖和旧块的重复项。是什么赋予了？

<!-- BEGIN GOOGLE ANALYTICS CODE -->
<script type="text/javascript">
//<![CDATA[
    var _gaq = _gaq || [];
    _gaq.push(["_setAccount", "UA-xxxxxx-x"]);
    _gaq.push(["_trackPageview", "/"]);

    (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    })();
//]]>
</script>
<!-- END GOOGLE ANALYTICS CODE -->

<!-- BEGIN GOOGLE ANALYTICS CODE -->
<script type="text/javascript">
//<![CDATA[
    (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
    })();

    var _gaq = _gaq || [];
    _gaq.push(["_setAccount", "UA-xxxxxx-x"]);
    _gaq.push(["_trackPageview", "/"]);
//]]>
</script>
<!-- END GOOGLE ANALYTICS CODE -->

加载块的 page.phtml 条目。

<?php echo $this->getChildHtml('after_body_start') ?>

googleanalytics.xml 布局

<layout version="0.1.0">
    <default>
        <!-- Mage_GoogleAnalytics -->
        <reference name="after_body_start">
            <block type="googleanalytics/ga" name="google_analytics" as="google_analytics" />
        </reference>
    </default>
</layout>

通过在战略位置使用Mage::Log() with 添加取证 由于我们在这里传递一个数组对象，它比使用字符串要复杂一些。$this->getData()

_toHtml() 函数的开始

2012-06-24T21:02:04+00:00 DEBUG (7): Array
(
    [type] => googleanalytics/ga
    [module_name] => Chief_GoogleAnalytics
)

立即使其 parent::_toHtml(); 加载 $original_output =parent::_toHtml

2012-06-24T21:02:04+00:00 DEBUG (7): Array
(
    [type] => googleanalytics/ga
    [module_name] => Chief_GoogleAnalytics
    [account] => UA-xxxxxx-x
    [page_name] => /
    [text] => 
<!-- BEGIN GOOGLE ANALYTICS CODE -->
<script type="text/javascript">
//<![CDATA[
    (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(ga);
    })();

    var _gaq = _gaq || [];
    _gaq.push(["_setAccount", "UA-xxxxxx-x"]);
    _gaq.push(["_trackPageview", "/"]);
//]]>
</script>
<!-- END GOOGLE ANALYTICS CODE -->

)

为了防止这变成一个 ;tldr，记录$this->getData();最后返回的位置，吐出两个 javascript，但与原来的相反。

$this->getData();在没有引用的情况下parent::_toHtml传递以下内容，这是我们想要的返回对象。一个具有适当标识符的脚本...

2012-06-24T21:06:24+00:00 DEBUG (7): Array
(
    [type] => googleanalytics/ga
    [module_name] => Chief_GoogleAnalytics
    [account] => UA-xxxxxx-x
    [page_name] => /aircraft
    [text] => 
<!-- BEGIN GOOGLE ANALYTICS CODE -->
<script type="text/javascript">
//<![CDATA[
    var _gaq = _gaq || [];
    _gaq.push(["_setAccount", "UA-xxxxxx-x"]);
    _gaq.push(["_trackPageview", "/aircraft"]);

    (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    })();
//]]>
</script>
<!-- END GOOGLE ANALYTICS CODE -->

)

Answer 1

首先，一个看似但并非真正迂腐的命名约定。当您将文件放入其中时local，这不是重写，而是代码池覆盖。当您创建自定义模块并使用rewrite节点时，这就是类重写。这是两种不同的行为，每一种行为都不同。这些差异就是您看到您所看到的行为的原因。

当您使用类覆盖时，您是在说

嘿 Magento，而不是包含你的类文件 a Mage_GoogleAnalytics_Block_Ga，而是包含我的

这完全取代了系统中的原始类。

当您使用类重写时，您是在说

嘿 Magento，当您实例化( googleanalytics/ga)Mage_GoogleAnalytics_Block_Ga块对象时，请从我的类中实例化该对象。

然后，通过让您的类扩展原始Mage_GoogleAnalytics_Block_Ga类，您可以拥有一个行为与原始对象相同的对象，并且您可以添加您的方法。但是，当您添加方法时，它们的父方法是原始块，这与覆盖不同。

第一步是删除本地代码池文件

app/code/local/Mage/GoogleAnalytics/Block/Ga.php

听起来你已经这样做了。接下来，在您重写的类中有方法。当你调用parent::_toHtml();方法时

protected function _toHtml()
{
    //... your stuff here ...
    return parent::_toHtml();
}

您是在告诉 Magento “嘿，做原始对象会做的任何事情”。使用块和_toHtml方法，这意味着产生相同的输出。这就是为什么你会得到“旧股票垃圾代码”。该_toHtml方法的约定是“无论返回什么字符串，都将包含在块输出中”。您的新代码也被包含在内，因为您正在使用addText您的父方法知道的方法。

所以，如果你想改变_toHtml块重写的行为，你需要做这样的事情

protected function _toHtml()
{
    $original_output = parent::_toHtml();
    $string = '';
    //... your code here which ultimately generates your output
    //and places it in $string
    return $string;
}

通过首先调用父方法，您可以确保从状态的角度来看块所做的任何事情仍然会发生（块不应该这样做，但是，我们知道这是怎么回事）。然后，您返回您的字符串。

Answer 2

DDx：注释掉<block type="googleanalytics/ga" ... />代码googleanalytics.xml会导致所有输出消失吗？

假设本地 codePool 覆盖文件已被删除，问题肯定是return parent::_toHtml()。父（核心）方法的 CE 1.4.1.1 版本使用addText()源自Mage_Core_Block_Text->_toHtml(). addText()会将内容附加到_data['text']，然后该方法将在渲染过程中返回此内容。因此，您的覆盖将一些字符串内容设置为_data['text']，然后当您调用父方法时，它将其内容添加到_data['text']然后调用Mage_Core_Block_Text->_toHtml()，它只是返回 的值_data['text']。

通常调用被覆盖的方法是个好主意，但在这种情况下它不起作用。鉴于此方法在 1.4.2.0 中已更改为仅从局部变量返回字符串，您应该可以忽略父级。如果由于某种奇怪的原因这不能解决问题，则可以使用布局 XML 将核心块实例替换为另一个。