Edit on GitHub

Area Editable

General

The area editable is similar to the areablock editable, the only difference is that the area bricks are not wrapped into a block element, and the editor cannot choose which area is used, this has to be done in the editable configuration in the template.

Configuration

Name Type Description
type string ID of the brick which should be used in this area
params array Optional Parameter see areablock for details
class string A CSS class that is added to the surrounding container of this element in editmode

Brick-specific Configuration

Brick-specific configurations are passed using the params configuration (see above).

Name Type Description
forceEditInView bool If a brick contains an edit.php there's no editmode for the view.php file, if you want to have the editmode enabled in both templates, enable this option
editWidth int Width of editing popup (if dedicated edit.php is used).
editHeight int Height of editing popup (if dedicated edit.php is used).

Methods

Name Return Description
getElement($name) Tag Retrieves an editable from within the actual area

Example

<div>
    <?= $this->area('myArea', ['type' => 'gallery-single-images']); ?>
</div>
{{ pimcore_area('myArea', { 'type' : 'gallery-single-images' }) }}

Example with Parameters

<div>
    <?= $this->area('myArea', [
        'type' => 'gallery-single-images',
        'params' => [
            'gallery-single-images' => [
                'param1' => 123,
                "forceEditInView" => true,
                "editWidth" => "800px",
                "editHeight" => "500px"
            ]
        ]
    ]); ?>
</div>

Get the params in your brick:

<div>
    <?= $this->param1; ?>
</div>

Accessing Data Within an Area Element

Assuming your area uses a brick gallery-single-images which contains a gallery block (see CMS demo):

<?php
// load document
$document = \Pimcore\Model\Document\Page::getByPath('/en/basic-examples/galleries');

/** @var \Pimcore\Model|Document\Tag\Area $area */
$area = $document->getElement('myArea');

/** @var \Pimcore\Model|Document\Tag\Block $block */
$block = $area->getElement('gallery');
?>

See Block for an example how to get elements from a block editable.