ModelCommon module

LayoutArea

A model in the Common module, with 26 members for templates, 23 API properties and 30 members for admin templates.

Common\Models\Frontend\LayoutArea Common\Models\Api\LayoutArea Common\Models\Backend\LayoutArea Also in Common: Address AddressCustomFieldValue Area Category CategoryCustomFieldValue ClientLlmCredential CollectionElement Component ComponentArea ComponentCollection Content Country Currency CustomField CustomFieldValue CustomUrl EditLock GlobalComponent GlobalComponentRevision GlobalComponentRevisionArea ImportDeduplication InputType InputTypePossibleValue Language Layout LayoutAreaGroup LayoutCategory LayoutCustomFieldValue SeoSettings SeoSettingsCustomFieldValue Setting SettingValue State Tag TagCustomFieldValue Widget WidgetSetting WidgetSettingValue

Templates view

Properties 26

Take no arguments.

# getAttributes(): Collection; Gets attributes list assigned to current layout area
# getId(): ?int
# getName(): ?string
# getLabel(): ?string
# getHelp(): ?string
# getInfo(): ?string
# isRequired(): bool
# getMin(): ?int
# getMax(): ?int
# getDefaultContent(): ?Content
# getCreated(): ?DateTime; Get the date the record was created.
# getModified(): ?DateTime; Get the last modification date for the record.
# isHidden(): bool
# getHidden(): ?DateTime
# getType(): ?InputType
# getLayout(): ?Layout
# getPosition(): ?int
# getSupportedLayouts(): ?Collection<Layout>
# isAttribute(): bool
# getParent(): ?LayoutArea
# getChildren(): Collection<LayoutArea>
# getGroup(): ?LayoutAreaGroup
# getSearchMasterIndexField(): ?MasterIndexField
# 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 23

Read-only values on the record.

# attributes: Collection; Gets attributes list assigned to current layout area
# id: ?int
# name: ?string
# label: ?string
# help: ?string
# info: ?string
# required: bool
# min: ?int
# max: ?int
# defaultContent: ?Content
# created: ?DateTime; Get the date the record was created.
# modified: ?DateTime; Get the last modification date for the record.
# hidden: bool
# hidden: ?DateTime
# type: ?InputType
# layout: ?Layout
# position: ?int
# supportedLayouts: ?Collection<Layout>
# attribute: bool
# parent: ?LayoutArea
# children: Collection<LayoutArea>
# group: ?LayoutAreaGroup
# searchMasterIndexField: ?MasterIndexField

Admin view

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

Properties 30