Relation

The Relation type can handle relations to other record types. They will be available to select from the Record Selector.

Settings

Name Type Default Required
allowed
 string (table name, comma-separated) true
maxitems
 integer
minitems
 integer
relationship
 string oneToMany

allowed

allowed
Type
string (table name, comma-separated)
Required

true

One or more tables, that should be referenced.

This table can be defined by another Content Block, but can also be an existing table defined by the Core or another extension.

maxitems

maxitems
Type
integer

Maximum number of items. Defaults to a high value. JavaScript record validation prevents the record from being saved if the limit is not satisfied.

minitems

minitems
Type
integer

Minimum number of items. Defaults to 0. JavaScript record validation prevents the record from being saved if the limit is not satisfied. The field can be set as required by setting minitems to at least 1.

relationship

relationship
Type
string
Default
oneToMany

The relationship defines the cardinality between the relations. Possible values are oneToMany (default), manyToOne and oneToOne. In case of a [x]toOne relation, the processed field will be filled directly with the record instead of a collection of records. In addition, maxitems will be automatically set to 1.

Examples

Minimal

name: example/relation
fields:
  - identifier: record_select
    type: Relation
    allowed: 'some_table'
Copied!

Advanced / use case

name: example/relation
fields:
  - identifier: page_select
    type: Relation
    allowed: 'pages'
    maxitems: 1
    suggestOptions:
      default:
        additionalSearchFields: 'nav_title, url'
        addWhere: 'AND pages.doktype = 1'
Copied!