Magento – Why use createBlock() and setTemplate() methods over creating a block via .xml file in /layout subdir

best practiceblockslayouttemplate

I've seen examples in extensions and in core where blocks are created through PHP code, e.g. in a controller action:

$block = $this->getLayout()->createBlock("company_module/...");

Or a block sets its own template, usually in the _construct()

$this->setTemplate("... .phtml");

I can see the programmatic approach being necessary if there is business logic involved that decides which block to create (or perhaps not create) and which .phtml template to set, depending on the circumstances.

But there are plenty of examples where there appears to be no business logic involved, yet the developer decided NOT to use the declarative approach of the .xml

Why would one want to NOT use .xml for creating blocks? What is best practice?

Best Answer

It depends on several things. This is because each and every developer has different approaches to different scenarios.

For an example, suppose I need to do change a template of a core block. I can do it programmatically or via layout update. Now some developers think in this way

"What I want to do is to just change a template. Then why should I define a new layout update file in config.xml, put the layout file in the theme folder and then construct xml to change the template of that block?? Let us approach this programmatically"

Now some people think this way

"I want to change the template of this block. It is clearly a layout update. So it should be done via layout update. Let us go with a new layout update file and do this in a fraction of second"

So this is purely depends upon a programmer. Someone like to do certain things in programmatic way. Some others love layout update technique. Both are correct and we can't blame anyone.

But suppose, if our module requires a lot of layout updates, then doing all those things programmatically will not be a good approach. In that case, we should consider to use a layout update xml file. That is more elegant and cleaner method. But for small layout udpates or if we want to apply some "dynamic logics" to layout, then it is convenient to go on with programmatic approach.

Related Solutions

Magento – Magento 1.8 – Display block in email template

I know that you can include static blocks using e.g.:

{{block type="cms/block" block_id="static-block-id" }}

That block simply uses _toHtml() to output the content from the static block.

protected function _toHtml()
{
    $blockId = $this->getBlockId();
    ...
    return $html;
}

Similarly, you could try and populate the _toHtml() function with HTML in your module to output what ever you need to output. You cannot use PHP variables such as $order to pass in your data for processing.

Magento – Magento 2.0.x – Insert block in to the product page

(1) first create a new module with a custom eav for your product content (this is just the InstallData.php content):

<?php namespace <vendor>\<module_name>\Setup;

use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;


/**
 * @codeCoverageIgnore
 */
class InstallData implements InstallDataInterface
{
    /**
     * EAV setup factory
     *
     * @var EavSetupFactory
     */
    private $eavSetupFactory;

    /**
     * Init
     *
     * @param EavSetupFactory $eavSetupFactory
     */
    public function __construct(EavSetupFactory $eavSetupFactory)
    {
        $this->eavSetupFactory = $eavSetupFactory;
        /* assign object to class global variable for use in other class methods */
    }

    /**
     * {@inheritdoc}
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        $setup->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);

        /**
         * Add attributes to the eav/attribute
         */
        $eavSetup->addAttribute(
            \Magento\Catalog\Model\Product::ENTITY,
            'my_attribute',
            [
                'type' => 'text',
                'backend' => '',
                'frontend' => '',
                'label' => 'my custom content',
                'input' => 'textarea',
                'class' => '',
                'source' => '',
                'global' => 1,
                'visible' => true,
                'required' => false,
                'user_defined' => true,
                'default' => 0,
                'searchable' => false,
                'filterable' => false,
                'comparable' => false,
                'visible_on_front' => false,
                'used_in_product_listing' => true,
                'wysiwyg_enabled' => true, // if you want a wysiwyg editor
                'unique' => false,
                'apply_to' => 'simple,configurable,virtual,bundle,downloadable,grouped',
                'group' => 'General'
            ]
        );
        $setup->endSetup();
    }
}

(2) in the module extend catalog_product_view.xml to insert your attribute: [I added mine as a new product tab]

<referenceBlock name="product.info.details">
    <block class="Magento\Catalog\Block\Product\View\Description" name="{SOME_NAME}" template="product/view/attribute.phtml" group="detailed_info">
        <arguments>
            <argument name="at_call" xsi:type="string">getMyAttribute</argument>
            <argument name="at_code" xsi:type="string">my_attribute</argument>
            <argument name="css_class" xsi:type="string">{some class if you like}</argument>
            <argument name="at_label" xsi:type="string">none</argument>
            <argument name="title" translate="true" xsi:type="string">My tab label</argument>
        </arguments>
    </block>
</referenceBlock>

(3) now you can go to your magento admin and insert custom content (even html) into the attribute content like for every other attribute

Best Answer

Related Solutions

Magento – Magento 1.8 – Display block in email template

Magento – Magento 2.0.x – Insert block in to the product page

Related Topic