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

时间:2012-06-24 17:43:14

标签: magento magento-1.4

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 Analytics异步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() $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 -->

)

2 个答案:

答案 0 :(得分:6)

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

当你使用类覆盖时,你说的是

  

Hey Magento,而不是包含Mage_GoogleAnalytics_Block_Ga的类文件,而不是包括我的

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

当你使用类重写时,你会说

  

Hey Magento,当您实例化 googleanalytics/gaMage_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;
}

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

答案 1 :(得分:2)

DDx:会对来自<block type="googleanalytics/ga" ... />的{​​{1}}代码进行评论,导致所有输出消失吗?

假设已删除本地codePool覆盖文件,问题肯定是googleanalytics.xml。父(核心)方法的CE 1.4.1.1版本使用return parent::_toHtml(),该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将核心块实例替换为另一个。