Documentation >
Content management >
Field types >
Field type reference >
RelationList field type

RelationList field type¶

This field type makes it possible to store and retrieve values of a relation to other content items.

Name	Internal name	Expected input
`RelationList`	`ibexa_object_relation_list`	`mixed`

PHP API field type¶

Input expectations¶

Type	Description	Example
`int\|string`	ID of the related content item	`42`
`array`	An array of related Content IDs	`[ 24, 42 ]`
`Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo`	ContentInfo instance of the related Content	n/a
`Ibexa\Core\FieldType\RelationList\Value`	RelationList field type value object	See below.

Value Object¶

Properties¶

Ibexa\Core\FieldType\RelationList\Value contains the following properties:

Property	Type	Description	Example
`destinationContentIds`	`array`	An array of related Content IDs	`[ 24, 42 ]`

// Value object content example
$relationList->destinationContentId = [
    $contentInfo1->id,
    $contentInfo2->id,
    170
];

Constructor¶

The RelationList\Value constructor initializes a new value object with the value provided. It expects a mixed array as value.

//Constructor example

// Instantiates a RelationList Value object
$relationListValue = new RelationList\Value(
    [
        $contentInfo1->id,
        $contentInfo2->id,
        170
    ]
);

Validation¶

This field type validates if:

the selectionMethod specified is \Ibexa\Core\FieldType\RelationList\Type::SELECTION_BROWSE or \Ibexa\Core\FieldType\RelationList\Type::SELECTION_DROPDOWN. A validation error is thrown if the value doesn't match.
the selectionDefaultLocation specified is null, string or integer. If the type validation fails a validation error is thrown.
the value specified in selectionContentTypes is an array. If not, a validation error in given.
the number of content items selected in the field isn't greater than the selectionLimit.

Note

The dropdown selection method isn't implemented yet.

Settings¶

The field definition of this field type can be configured with the following options:

Name	Type	Default value	Description
`selectionMethod`	`mixed`	`SELECTION_BROWSE`	Method of selection in the back-end interface.
`selectionDefaultLocation`	`string\|integer`	`null`	ID of the default Location for the selection when using the back-end interface.
`selectionContentTypes`	`array`	`[]`	An array of content type IDs that are allowed for related Content.

Following selection methods are available:

Name	Description
`SELECTION_BROWSE`	Selection uses browse mode.
`SELECTION_DROPDOWN`	Not implemented yet

Validators¶

Name	Type	Default value	Description
`RelationListValueValidator[selectionLimit]`	`integer`	`0`	The number of content items that can be selected in the field. When set to 0, any number can be selected.

// Example of using settings and validators configuration in PHP

use Ibexa\Core\FieldType\RelationList\Type;

$fieldSettings = [
    "selectionMethod" => Type::SELECTION_BROWSE,
    "selectionDefaultLocation" => null,
    "selectionContentTypes" => []
 ];

$validators = [
    "RelationListValueValidator" => [
        "selectionLimit" => 0,
    ]
];

GraphQL integration¶

This field type is paginating the results when queried using GraphQL. To learn more, see Pagination in GraphQL.