ModelMenus module

ControllerParameter

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

Menus\Models\Frontend\ControllerParameter Menus\Models\Api\ControllerParameter Menus\Models\Backend\ControllerParameter Also in Menus: Element ElementCustomFieldValue Menu MenuCustomFieldValue
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.

# getId()
?int
# getName()
?string
# getValue()
?string
# getPropertyValues()
?array
# getElement()
?Element
# 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.

# id
?int
# name
?string
# value
?string
# propertyValues
?array
# element
?Element

Admin view

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

Properties 14

Take no arguments.

# getId()
?int
# getName()
?string
# getValue()
?string
# getPropertyValues()
?array
# getElement()
?Element
# 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
# getEditor() Admin only
?string
# isRequired() Admin only
?bool
# getLabel() Admin only
?string
# getAvailableModels() Admin only
?Collection
# getDisplayProperty() Admin only
?string
# getOptions() Admin only
?array