| Method | Description | Returns |
|---|---|---|
| getId() | int | |
| getName() | string | |
| getType() | string | |
| getUrl() | 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() | 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 |
| 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 |
| getAvailableParents() | Get the available parents for the element. Fetches only elements that do not have the parent. You can access children calling {@link getChildren()}. Consider that current element will be also inside returned data. | Collection |
| getHateoasLinks() | Get the HATEOAS links for the record | array |
| getCreateChildUrl() | Get the url for creating a child record. | string |
| getEditUrl() | Get the url for editing the record. | string |
| getMoveUrl() | Get the url for moving the record. | string |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getPublishUrl() | Get the url for publishing the record. | string |
| getManageUrl() | Get the url for managing records. | string |
Menus\Models\Backend\Element
Element