The Relation Field Type

Written by Ricardo Correia Updated 01/28/2016 by Dominika Kurek

This Field Type represents a relation to a Content item.

Name	Internal name	Expected input
Relation	ezobjectrelation	mixed

Table of contents:

Description

This Field Type makes it possible to store and retrieve the value of relation to a Content item.

Type	Example
string	"150"
integer	150

The Value class of this Field Type contains the following properties:

Property	Type	Description
$destinationContentId	string\|int\|null	This property will be used to store the value provided, which will represent the related content.

Value object content example

The Relation\Value constructor will initialize a new Value object with the value provided. It expects a mixed value.

Constructor example

This Field Type validates whether the provided relation exists, but before it does that it will check that the value is either string or int.

The field definition of this Field Type can be configured with two options:

Name	Type	Default value	Description
selectionMethod	int	self::SELECTION_BROWSE	This setting defines the selection method. It expects an integer (0/1). 0 stands for self::SELECTION_BROWSE, 1 stands for self::SELECTION_DROPDOWN.
selectionRoot	string	null	This setting defines the selection root.

Relation FieldType example settings

Note: These settings are meant for future use in user interface when allowing users to select relations.

Add a comment