| Method | Description | Returns |
|---|---|---|
| isLocal() | Returns the information that this is a local component | bool |
| isGlobal() | Returns the information that this is not a global component | bool |
| isBlank() | Returns the information that this is not a blank component | bool |
| getAreas() | Collection | |
| getAreaGroups() | Gets the layout area groups | Collection |
| getAreaContent(string $areaName) | Get the content of the layout area Will return a BlankContent if no content was defined | Content |
| getAreaDefaultContent(string $areaName) | Get the default content of the layout area Will return a BlankContent if no content was defined | Content |
| getAreaContentOrDefault(string $areaName) | Get the content of the layout area, or the default content if no content exists If no default content exists, a BlankContent will be returned | Content |
| getAreaAttributesContent(string $areaName) | Gets the content of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getAreaAttributesDefaultContent(string $areaName) | Gets the default content of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getAreaAttributesContentOrDefault(string $areaName) | Gets the content (or the default content if no content exists) of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getEntityAreaByLayoutArea(LayoutArea $area) | Get the link record between the layout area and content for the designated layout area | Model |
| hasAreaWithName(string $areaName) | Check if an area with the specified name exists for the container | bool |
| getAreaType(string $areaName) | Get the input type for the specified layout area. Returns null if the area with the specified name could not be found. | InputType |
| getAreaCategory(string $areaName) | Get the category for the specified layout area. Returns null if the area with the specified name could not be found. | string |
| getAreaEditor(string $areaName) | Get the editor for the specified layout area. Returns null if the area with the specified name could not be found. | string |
| getAreaImage(string $areaName) | Get the image for the layout area with the specified name Will return a BlankImage if no image was defined | Image |
| getAreaFile(string $areaName) | Get the file for the layout area with the specified name | File |
| getAreaRecord(string $areaName) | Get the record for the layout area with the specified name | Model |
| getAreaRecords(string $areaName) | Get the records for the layout area with the specified name | Collection |
| getAreaText(string $areaName) | Get the text for the layout area with the specified name | string |
| getAreaValues(string $areaName) | Get the values for the layout area with the specified name | array |
| getAreaDate(string $areaName) | Get a date for the layout area with the specified name | DateTime |
| getAreaWidget(string $areaName) | Get the widget for the layout area with the specified name Will return a BlankWidget if no image was defined | Widget |
| getAreaComponent(string $areaName) | Get the component for the layout area with the specified name Will return a BlankComponent if no image was defined | Component |
| getAreaCollectionElements(string $areaName) | Get the component collection elements for the layout area with the specified name | Collection |
| getAreaHtml(string $areaName) | Get the rendered HTML for the component area with the specified name. Adds live preview tags, if enabled. | string |
| getHtml(array $variables) | Gets the rendered HTML content for this component | string |
| getId() | int | |
| getName() | string | |
| getLayout() | Layout | |
| getGlobal() | GlobalComponent | |
| getComponentAreas() | Collection (ComponentArea) | |
| getTags() | Collection (Tag) | |
| getCategories() | Collection (Category) | |
| 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 |
| getAreaImageOrPlaceholder(string $areaName, int $width, int $height) | Get the image for the component area with the specified name If the image does not exist, get a placeholder image with the specified dimensions Will always return an image, even if it was not found (in that case, an empty image) | Image |
Common\Models\Frontend\Component
Component