Download the PHP package tkotosz/block-decorator-magento2 without Composer
On this page you can find all versions of the php package tkotosz/block-decorator-magento2. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tkotosz/block-decorator-magento2
More information about tkotosz/block-decorator-magento2
Files in tkotosz/block-decorator-magento2
Package block-decorator-magento2
Short Description Tkotosz - Block Decorator module for Magento 2
License MIT
Informations about the package block-decorator-magento2
BlockDecorator module for Magento 2
This module allows it to decorate Blocks used in the layout with extra data based on interfaces implemented by the blocks.
Installation
Install by adding to your composer.json
:
How it works?
The module registers an "after plugin" for the Magento\Framework\View\Element\BlockFactory
which used by Magento to instantiate Blocks. In this plugin the block object created by the factory passed over to all registered decorators to decorate the block with extra data if needed. Each decorator is responsible for checking the type of the block and decide whether it needs to do anything.
How to use?
-
Create an interface which can be implemented by any block to get a specific data. (example:
Tkotosz\BlockDecorator\View\Element\Block\CurrentProduct\ProductNameAwareInterface
) -
Create your block class in the same way as you do it normally and implement your interface created in the 1st step. (example:
Tkotosz\BlockDecorator\Block\Product\View\ProductName
) -
Create your own decorator which can decorate the blocks with the required data when applicable (when your interface is implemented by the block). To create a the decorator you just need to create a new class which implements the
Tkotosz\BlockDecorator\View\Element\Block\Decorator\DecoratorInterface
. (example:Tkotosz\BlockDecorator\View\Element\Block\Decorator\CurrentProductName
) - Register your decorator in the Magento di like this:
(example: see how Tkotosz\BlockDecorator\View\Element\Block\Decorator\CurrentProductName
is registered in the src/etc/di.xml
)
- Add your new block to any layout, when the block is instantiated your decorator will run to set the required data, which later can be used when the block is rendered.
All versions of block-decorator-magento2 with dependencies
magento/framework Version ^100.1|^101.0|^102.0
magento/module-catalog Version ^101.0|^102.0|^103.0