除模块覆盖外,还会出现覆盖块

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 /模块/ Chief_GoogleAnalytics.xml

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

应用程序/代码/本地/首席/ Google分析的/ 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>

应用程序/代码/本地/首席/ Google分析/座/ 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中显示,以便正常工作.这是新的Block overwrite和old Block显示的重复项.是什么赋予了？

<!-- 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();返回结束的位置,吐出两个javascripts,但是与原始版本相反.

$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,而不是包括你的类文件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;
}

通过首先调用父方法,您可以确保块状态从状态的角度来看仍然发生(块不应该这样做,但是,我们知道这是怎么回事).然后,您将返回您的字符串.