Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   eZ Publish 4.x / legacy

 
eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: sync structure

Table of Contents
minLevel2

Short description

 

This field type represents one or multiple relations to content.

NameInternal nameExpected input
RelationListezobjectrelationlistmixed

Table of contents:

Table of Contents
minLevel2

Input expectations

Type
Description
Example
int|stringId of the related Content42
arrayAn array of related Content idsarray( 24, 42 )
eZ\Publish\API\Repository\Values\Content\ContentInfo

ContentInfo instance of the related Content

 
eZ\Publish\Core\FieldType\RelationList\ValueRelationList FieldType Value ObjectSee Value Object documentation section below.

Value Object API

Properties

eZ\Publish\Core\FieldType\RelationList\Value offers  contains following properties.

PropertyTypeDescriptionExample

destinationContentIds

arrayAn array of related Content idsarray( 24, 42 )
Code Block
languagephp
titleValue object content example
linenumberstrue
$relationList->destinationContentId = array( 
	$contentInfo1->id,
	$contentInfo2->id,
	170
);

Constructor

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

Code Block
languagephp
titleConstructor example
linenumberstrue
// Instantiates a RelationList Value object
$relationListValue = new RelationList\Value(
	array(
		$contentInfo1->id,
		$contentInfo2->id,
		170		
	)
);

Validation

This FieldType validates if the selectionMethod specified is 0 (self::SELECTION_BROWSE) or 1 (self::SELECTION_DROPDOWN). A validation error is thrown if the value does not match.

...

NameTypeDefault valueDescription

selectionMethod

mixed
SELECTION_BROWSE
Method of selection in the administration interface

selectionDefaultLocation

string|integernullId of the default Location for the selection when using administration interface

selectionContentTypes

arrayarray()An array of ContentType ids that are allowed for related Content

 

Following selection methods are available:

...

Code Block
languagephp
titleExample of using settings in PHP
linenumberstrue
use eZ\Publish\Core\FieldType\RelationList\Type;

$settings = array(
	"selectionMethod" => Type::SELECTION_BROWSE,
	"selectionRoot" => null,
    "selectionContentTypes" => array()
 );

Value object

Properties

The Value class of this field type contains the following properties:

PropertyTypeDescription
$destinationContentIdsmixed[]This property will be used to store the values provided, in the form of a mixed array, which will represent the related content list.
Code Block
languagephp
titleValue object content example
linenumberstrue
$relationList->destinationContentId = array( 
	$contentInfo1->id,
	$contentInfo2->id,
	170
);

Constructor

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

Code Block
languagephp
titleConstructor example
linenumberstrue
// Instantiates a RelationList Value object
$relationListValue = new RelationList\Value(
	array(
		$contentInfo1->id,
		$contentInfo2->id,
		170		
	)
);