| Method | Description | Returns |
|---|---|---|
| getAreaByName(string $areaName) | Fetch a layout area with the given name | LayoutArea |
| getId() | int | |
| getController() | string | |
| getTemplate() | string | |
| getName() | string | |
| getIdentifier() | string | |
| getText() | string | |
| getCreated() | Get the date the record was created. | DateTime |
| getModified() | Get the last modification date for the record. | DateTime |
| isHidden() | bool | |
| getHidden() | DateTime | |
| getSite() | Site | |
| getAreas() | Collection (LayoutArea) | |
| getAreaGroups() | Collection (LayoutAreaGroup) | |
| getImage() | Image | |
| getCategory() | LayoutCategory | |
| getCustomFieldValues() | Collection (LayoutCustomFieldValue) | |
| 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 |
| isVersionedModel() | Check whether a model is versioned | bool |
| getAvailableInputTypes() | Get the available input types | Collection |
| getRootCategories() | Get the root layout categories | Collection |
| getAvailableTemplates() | Get the available templates | array |
| hasAttributes() | Check whether the layout has attributes without attachment to a layout area | bool |
| getAttributes() | Check whether the layout has attributes without attachment to a layout area | Collection |
| getHateoasLinks() | Get the HATEOAS links for the record | array |
| getEditUrl() | Get the url for editing the record. | string |
| getManageUrl() | Get the url for managing records. | string |
Common\Models\Backend\Layout
Layout