ModelCommon module

ComponentArea

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

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

Take no arguments.

# getId()
?int
# getComponent()
?Component
# getArea()
?LayoutArea
# getContent()
?Content
# getContentOrDefault()
?Content
Retrieves entity area content. If empty, retrieves default content of the area or its input type.
# 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

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.

# id
?int
# component
?Component
# area
?LayoutArea
# content
?Content
# contentOrDefault
?Content
Retrieves entity area content. If empty, retrieves default content of the area or its input type.

Admin view

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

Properties 7

Take no arguments.

# getId()
?int
# getComponent()
?Component
# getArea()
?LayoutArea
# getContent()
?Content
# getContentOrDefault()
?Content
Retrieves entity area content. If empty, retrieves default content of the area or its input type.
# 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