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:

Relation (Many-To-One) Editable

General

The relation editable provides the functionality to create a reference to an other element in Pimcore (document, asset, object). In frontend-mode this editable returns the path of the linked element.

Configuration

Name	Type	Description
`types`	array	Allowed types (document, asset, object), if empty all types are allowed
`subtypes`	array	Allowed subtypes grouped by type (folder, page, snippet, image, video, object, ...), if empty all subtypes are allowed (see example below)
`classes`	array	Allowed object class names, if empty all classes are allowed
`reload`	boolean	`true` triggers page reload on each change
`width`	int	Width of the field in pixel.
`uploadPath`	string	Target path for (inline) uploaded assets
`class`	string	A CSS class that is added to the surrounding container of this element in editmode

Methods

Name	Return	Description
`getElement()`	Element	Get the assigned element
`getFullPath()`	string	Get the full path of the assigned element.
`isEmpty()`	boolean	Whether the editable is empty or not

Examples

Basic usage

You can just create the code line like, below:

<?= $this->relation("myRelation"); ?>

{{ pimcore_relation("myRelation") }}

After, the view in the administration panel changes like in the picture:

Relation editable preview in the administration panel

Using Restriction

If you want specify elements which could be assigned to the relation editable, use types, subtypes and classes options in the editable configuration.

Example

<?= $this->relation("myRelation", [
    "types" => ["asset","object"],
    "subtypes" => [
        "asset" => ["video","image"],
        "object" => ["object"]
     ],
    "classes" => ["person"],
]); ?>

{{ pimcore_relation("myRelation",{
    "types": ["asset","object"],
    "subtypes": {
        "assets": ["video", "image"],
        "object": ["object"],
    },
    "classes": ["person"]
}) }}

We restricted the myRelation editable to the following entities:

Video / Image (Assets)
Person Objects (\Pimcore\Model\DataObject\Person) (Objects)

As you see in the picture below, it's impossible to drop any other type to that editable.

Relation restriction

Download Example

Another useful use-case for the relation editable is a download link.

<?php if ($this->editmode): ?>
    <?= $this->relation("myRelation"); ?>
<?php else: ?>
    <?php if ($this->relation("myRelation")->getElement() instanceof Asset): ?>
        <a href="<?= $this->relation("myRelation")->getFullPath() ?>"><?= $this->translate("Download") ?></a>
    <?php endif; ?>
<?php endif; ?>

{% if editmode %}
    {{ pimcore_relation("myRelation") }}
{% else %}
    {% if pimcore_relation("myRelation").getElement() is instanceof('\\Pimcore\\Model\\Asset')  %}
        <a href="{{ pimcore_relation("myRelation").getFullPath() }}">{{ "Download" | trans }}</a>
    {% endif %}
{% endif %}