在magento 2中哪些块方法在模板中可用?

时间:2018-05-26 17:18:12

标签: magento2 getter public-method

m2与m1大不相同。

当我在模板中编写代码(编写公共方法)时,它们似乎不起作用。是否允许所有方法都受保护和私有?或吸气剂或只是公共吸气剂?我很困惑。

我认为只有公众吸气者对吗?

非常感谢任何帮助。

1 个答案:

答案 0 :(得分:1)

模板中提供了块上下文中的所有公共方法。

阻止上下文是您在布局XML中分配给模板的阻止class。它相当于Magento 1中的阻止type。默认情况下,它是\Magento\Framework\View\Element\Template,相当于Magento 1中的Mage_Core_Block_Template

此块上下文在呈现期间作为$block变量分配给模板。这与Magento 1不同,其中$this指的是模板中的块上下文。在Magento 2中,$this指的是负责呈现模板的模板引擎。您可以在render method of the template engine中看到这一切,其中$dictionary参数(包含$block等参数)extracted就在包含phtml文件之前。这允许在模板中使用所有提取的变量,特别是$block

示例块使用

假设您已在模块中创建了一个自定义块类,如此app/code/MyNamespace/MyModule/Block/MyBlock.php

<?php 

namespace MyNamespace\MyModule\Block;

use Magento\Framework\View\Element\Template;

class MyBlock extends Template
{
    public const FOO = 'foo';
    private const BAR = 'bar';

    public function isFoo(string $str): bool 
    {
        return $str === self::FOO;
    }

    private function isBar(string $str): bool
    {
        return $str === self::BAR;
    }
}

您可以通过在此app/code/MyNamespace/MyModule/view/frontend/layout/catalog_product_view.xml中创建文件,将此块添加到每个产品页面中。

<?xml version="1.0"?>

<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="content">
            <block class="MyNamespace\MyModule\Block\MyBlock" name="myblock" template="MyNamespace_MyModule::mytemplate.phtml" />
        </referenceContainer>
    </body>
</page>

这会在每个产品页面的MyBlock - 容器中添加content。容器将自动渲染其子块,因此它们类似于Magento 1中的core/text_list块类型。

然后,在布局XML app/code/MyNamespace/MyModule/view/frontend/templates/mytemplate.phtml中配置的模板中,您可以使用公共方法和属性,包括isFoo,但不能使用isBar等私有或受保护的方法和属性。模板文件开头的文档评论清楚地说明$this$block是什么。

<?php
/** @var $this \Magento\Framework\View\TemplateEngine\Php */
/** @var $block \MyNamespace\MyModule\Block\MyBlock */
$thing1 = 'foo';
$thing2 = 'bar';
?>
<div class="my-thing">
    <?php if ($block->isFoo($thing1)): ?>
        <!-- isFoo works since it's a public method -->
    <?php endif; ?>
    <?php if ($block->isBar($thing2)): ?>
        <!-- isBar doesn't work since it's a private method -->
    <?php endif; ?>

    <!-- You can access public properties and constants from the $block object, too -->
    <span><?php echo $block::FOO; ?></span>
</div>