Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This Field Type represents a relation to a Content item.
| Name | Internal name | Expected input |
|---|---|---|
Relation | ezobjectrelation | mixed |
Description
This Field Type makes it possible to store and retrieve the value of relation to a Content item.
PHP API Field Type
Input expectations
| Type | Example |
|---|---|
string | "150" |
integer | 150 |
Value object
Properties
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. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
$relation->destinationContentId = $contentInfo->id; |
Constructor
The Relation\Value constructor will initialize a new Value object with the value provided. It expects a mixed value.
| Code Block | ||||
|---|---|---|---|---|
| ||||
// Instantiates a Relation Value object $relationValue = new Relation\Value( $contentInfo->id ); |
Validation
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.
Settings
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
| ||
selectionRoot | string | null | This setting defines the selection root. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
use eZ\Publish\Core\FieldType\Relation\Type; $settings = array( "selectionMethod" => 1, "selectionRoot" => null ); |
Note: These settings are meant for future use in user interface when allowing users to select relations.