Layouts Data¶

Types of Data in the Context¶

The layout context can hold any types of data, including scalars, arrays and objects. But any object you want to put in the context must implement the ContextItemInterface.

Accessing Context¶

Context can be accessed in a few ways. The most common of them are:

1. Accessing context from the BlockInterface instance. For example, when you need to get values from context when building the view.

   For example:

   1 2 3 4 5 6 7

   /** * {@inheritdoc} */ public function buildView(BlockView $view, BlockInterface $block, Options $options) { $value = $block->getContext()->get('value-key'); }

2. Accessing context using the Symfony expression component by providing an expression as an option for some block.

   For example:

   1 2 3 4 5 6 7 8

   actions: ... - '@add': id: blockId parent: parentId blockType: typeName options: optionName: '=context["valueKey"]'

Context Configurators¶

It might be required to configure the context based on the current application state, client setting, or to define the default values, etc. In order to prevent copypasting of the boilerplate code, context configurators have been introduced.

Each configurator should implement the ContextConfiguratorInterface, and be registered as a service in the DI container with the layout.context_configurator tag.

For debugging purposes, the oro:layout:debug –context command has been added. It allows to see how the context data-resolver will be configured by the context configurators.

Types of Data Providers¶

You can provide data for layouts in two ways:

• By adding them to the data collection of the layout context. This method can be used for page specific data, or the data retrieved from the HTTP request.
• By creating a standalone data provider. This method is useful if data is used on many pages and the data source is a database, HTTP session, external web service, etc.

Using the Layout Context as Data Provider¶

If you want to add some data to the layout context, you can use the data method of layout context. This method returns an instance of ContextDataCollection. Use the set method of this collection to add data:

1
2
3
4

$context->data()->set(
    'widget_id',
    $request->query->get('_wid')
);

The set method has the following arguments:

• $name – A string which can be used to access the data.
• $value – The actual data. The data can be any type, for example an array, object or some scalar type.

You can also create Context Configurators to set the default data:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

$context->data()->setDefault(
    'widget_id',
    function () {
        if (!$this->request) {
            throw new \BadMethodCallException('The request expected.');
        }

        return $this->request->query->get('_wid');
    }
);

The setDefault method has the following arguments:

• $name – A string which can be used to access the data.
• $value – The data. The data can be any type, for example an array, object or some scalar type. You can also use the callback method to get the data. The callback definition is as follows: function (array|ArrayAccess $options) : mixed, where the $options argument represents the context variables.

Defining a Data Provider¶

As example, consider a data provider that returns product details:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

namespace Acme\Bundle\ProductBundle\Layout\Extension;

use Acme\Bundle\ProductBundle\Entity\Product;

class ProductDataProvider
{
    /**
     * @param Product $product
     */
    public function getCode(Product $product)
    {
        return $product->getId();
    }
}

You can also implement the AbstractFormProvider if you use forms.

Registering a Data Provider¶

To make the layout engine aware of your data provider, register it as a service in the DI container with the layout.data_provider tag:

1
2
3
4

acme_product.layout.data_provider.product:
    class: Acme\Bundle\ProductBundle\Layout\DataProvider\ProductProvider
    tags:
        - { name: layout.data_provider, alias: product }

The alias key of the tag is required and should be unique for each data provider. This alias is used to get the data provider from the registry.

Accessing Providers Data¶

There are few ways to access data provider data. The most common ways are:

1. Accessing data from the BlockInterface instance. For example, when you need to get data when building the view.

   Example:

   1 2 3 4 5 6 7 8 9

   /** * {@inheritdoc} */ public function buildView(BlockView $view, BlockInterface $block, Options $options) { /** @var Product $product */ $product = $block->getData()->get('product'); $productCode = $product->getCode(); }

2. Accessing data using the Symfony expression component by providing the expression as an option for a block.

   Example:

   1 2 3 4 5 6 7 8

   actions: ... - '@add': id: product_code parent: product_details blockType: text options: text: '=data["product"].getCode()'

The way how you access the data does not depend on where the data are located, in the layout context or in the standalone data provider. But it is important to remember that standalone data providers have higher priority than data from the layout context.

It means that if there are data with the same alias in both the layout context and a standalone data provider registry, the standalone data provider will be used.