ModelCustomEntities module

Relationship

RecordRelationship

A model in the CustomEntities module, with 8 members for templates, 5 API properties and 8 members for admin templates.

CustomEntities\Models\Frontend\Relationship CustomEntities\Models\Api\Relationship CustomEntities\Models\Backend\Relationship Also in CustomEntities: Definition Record RecordArea RecordRevision RelationshipDefinition
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 8

Take no arguments.

# getRecord()
?Record
Get the record for in this relationship, or the first record if multiple records are supported
# getId()
?int
# getDefinition()
?RelationshipDefinition
# getOwningRecord()
?Record
# getRecords()
?Collection<Record>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 5

Read-only values on the record.

# record
?Record
Get the record for in this relationship, or the first record if multiple records are supported
# id
?int
# owningRecord
?Record
# records
?Collection<Record>

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 8

Take no arguments.

# getRecord()
?Record
Get the record for in this relationship, or the first record if multiple records are supported
# getId()
?int
# getDefinition()
?RelationshipDefinition
# getOwningRecord()
?Record
# getRecords()
?Collection<Record>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned