ModelCommon module

LayoutCategory

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

Common\Models\Frontend\LayoutCategory Common\Models\Api\LayoutCategory Common\Models\Backend\LayoutCategory 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 LayoutArea LayoutAreaGroup 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 10

Take no arguments.

# getId()
?int
# getName()
?string
# getPosition()
?int
# getParent()
?LayoutCategory
# getLayouts()
?Collection<Layout>
# getChildren()
?Collection<LayoutCategory>
# getFullPosition()
string
Get the full, dot-separated full position for hierarchical records
# 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 7

Read-only values on the record.

# id
?int
# name
?string
# position
?int
# parent
?LayoutCategory
# layouts
?Collection<Layout>
# fullPosition
string
Get the full, dot-separated full position for hierarchical records

Admin view

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

Properties 15

Take no arguments.

# getId()
?int
# getName()
?string
# getPosition()
?int
# getParent()
?LayoutCategory
# getLayouts()
?Collection<Layout>
# getChildren()
?Collection<LayoutCategory>
# getFullPosition()
string
Get the full, dot-separated full position for hierarchical records
# 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
# getAvailableParents() Admin only
Collection
Get the available parents for this layout category. Only fetches categories that aren't the current category.
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getManageUrl() Admin only
?string
Get the url for managing records.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.