Development Documentation Documents Editables Areablock

Warning: You are browsing the documentation from version 4 to 10 of Pimcore. Please visit https://pimcore.com/docs/platform/ for the latest versions of Pimcore.
Version: Edit on GitHub

Areablock Editable

General

The areablock is the content construction kit for documents offered by Pimcore.

Admin panel preview 1

Admin panel preview 2

Integrate an Areablock in a Template

Similar to the other document editables, an areablock can be integrated in any document view template as follows:

{{ pimcore_areablock("myAreablock") }}

Advanced usage with allowed areas, below:

{{ pimcore_areablock("myAreablock", {
            "allowed": ["iframe","googletagcloud","spacer","rssreader"],
            "group": {
                "First Group": ["iframe", "spacer"],
                "Second Group": ["rssreader"]
            },
            "globalParams": {
                "myGlobalParam": "Global param value"
            },
            "params": {
                "iframe": {
                    "parameter1": "value1",
                    "parameter2": "value2"
                },
                "googletagcloud": {
                    "param1": "value1"
                }
            }
        })
    }}
Accessing Parameters from the Brick File

Use the value of parameter named "param1" for this brick:

{{ param1 }}
Sorting Items in the menu
{{ pimcore_areablock("content", {
    "allowed": ["image","video","wysiwyg"],
    "sorting": ["wysiwyg","video","image"],
}) }}

And you can see the effect, below:

Admin panel preview - sroting areablocks

Configuration

Name Type Description
allowed array An array of area-ID's which are allowed for this tag. The order of items in the array is also used as the default sorting, but of course you can combine this configuration with sorting
sorting array An array of area-ID's in the order you want to display them in the menu.
params array Optional parameter, this can also contain additional brick-specific configurations, see brick-specific configuration
globalParams array Same as params but passed to all bricks independent from the type
group array Array with group configuration (see example above).
manual bool Forces the manual mode, which enables a complete free implementation for areablocks, for example using real <table> elements... example see below
reload bool Set to true, to force a reload in editmode after reordering items (default: false)
dontCheckEnabled bool Set to true to display all installed area bricks, regardless if they are enabled in the extension manager
limit int Limit the amount of elements
limits array An array of area-ID's with count to limit the amount of certain elements e.g. {"iframe": 1, "teasers": 2}
areablock_toolbar array Array with option that allows you to configure the toolbar. Possible options are width, buttonWidth and buttonMaxCharacters
controlsAlign string The position of the control button bar. Options are: top, right and left.
controlsTrigger string Options are: hover(default) and fixed .
class string A CSS class that is added to the surrounding container of this element in editmode
Example
{{ pimcore_areablock("myArea") }}

Methods

Name Return Description
getCount() int Total count of blocks
getCurrent() int Current number of block (useful with area bricks)
getCurrentIndex() int Get the current index (index is different from position, as you can move block around)
getElement() array Get an element out of an areabrick
renderIndex() - Renders only one specific block within the areablock

How to Create Bricks for the Areablock

You can read about bricks in the Bricks section.

Limit certain Bricks for the Areablock

You can limit certain bricks for the Areablock by using limits configurations.

Example
{{ pimcore_areablock("myAreablock", {
        "allowed": ["iframe","teasers","wysiwyg"],
        "limits": {
            "iframe": 1,
            "teasers": 2
        },
        "limit": 5
    })
}}

Using Manual Mode

The manual mode offers you the possibility to use areablocks with custom HTML, this is for example useful when using tables:

{% set areaBlock = pimcore_areablock("myArea", {"manual":true}) %}

{% do areaBlock.start() %}
<table>
    {% for i in areaBlock.iterator %}
        {% set info = areaBlock.buildInfoObject() %}
        {% do areaBlock.blockConstruct() %}
            <tr>
                <td>
                    {% set templateParams = areaBlock.blockStart(info) %}
                    {% do areaBlock.content(info, templateParams) %}
                    {% do areaBlock.blockEnd() %}
                </td>
            </tr>
        {% do areaBlock.blockDestruct() %}
    {% endfor %}
</table>
{% do areaBlock.end() %}

Accessing Data Within an Areablock Element

See Block for an example how to get elements from block and areablock editables.