Method | Description | Returns |
---|---|---|
getId() | int | |
getName() | string | |
getType() | string | |
getUrl() | Get the URL for this menu element | string |
getControllerName() | string | |
getController() | string | |
getModuleRoute() | string | |
getControllerRoute() | string | |
getResponseVariable() | string | |
getIncludeChildren() | bool | |
getDisplayProperty() | string | |
getPosition() | int | |
getEntity() | string | |
getRecordId() | int | |
getCreated() | DateTime | |
getModified() | DateTime | |
getParent() | Element | |
getChildren() | Get the children of this menu element | Collection (Element) |
getMenu() | Menu | |
getControllerParameters() | Collection (ControllerParameter) | |
getSite() | Site | |
getPublished() | Date at which the page was published | DateTime |
isPublished() | Determines if the record is published. | bool |
getCustomFieldValues() | Collection (ElementCustomFieldValue) | |
getCustomFieldValue(CustomField $customField) | Get the value for a custom field | CustomFieldValue |
getCustomFieldValueByName(string $customFieldName) | Get the value for a custom field by the custom field name | CustomFieldValue |
getCustomFieldContent(string $customFieldName) | Get the content for the custom field identified by the specified name | Content |
getCustomFieldContentOrDefault(string $customFieldName) | Get the content (or default content) for the custom field identified by the specified name | Content |
getCustomFieldBoolean(string $customFieldName, ?bool|null $default) | Get the (default) content of the custom field as boolean value | bool |
getCustomFieldText(string $customFieldName, ?string|null $default) | Get the (default) content of the custom field as text | string |
getCustomFieldImage(string $customFieldName) | Get the (default) image contained in the custom field | Image |
getCustomFieldFile(string $customFieldName) | Get the (default) file contained in the custom field | File |
getCustomFields() | Get the custom fields for this entity | array |
hasCustomField(string $customFieldName) | Check if the entity has a custom field with the specified name | bool |
getFullPosition() | Get the full, dot-separated full position for hierarchical records | string |
isNewRecord() | Check if the record is a new record | bool |
isHierarchicalModel() | Check whether a model is a hierarchical model, i.e. can have children | bool |
isVersionedModel() | Check whether a model is versioned | bool |
isActive() | Check if the current menu element is active | bool |
hasActiveChild() | Check if the current menu element is active | bool |
hasChildren() | Check whether the menu element has children | bool |
getAllParents() | Get all parents for the current record, ordered by root record => the closest record | Collection |
Menus\Models\Frontend\Element
Element