| Method | Description | Returns |
|---|---|---|
| getOriginalPath() | Get the original path for the category without any custom urls applied | string |
| getFullSlug() | Get the full slug for this description | string |
| getFullPath() | Get the full path including the module route name | string |
| getAssignedWorkflow() | Get the workflow assigned to the record or entity | Workflow |
| hasAssignedWorkflow() | Check whether the record has an assigned workflow | bool |
| getBranches() | Get the branches associated with the record | Collection |
| getBranchRevisions(RevisionBranch $branch) | Get the revisions for the provided branch | Collection |
| getNumRevisionsWithoutBranch() | Get the number of revisions without branch | int |
| getRevisionsWithoutBranch() | Get all revisions without branch | Collection |
| getActiveRevision() | CategoryDescriptionRevision | |
| getCategory() | Category | |
| getContainer() | Returns the category as the container of the description | Category |
| getLastRevision() | Get the last revision for the entity. If a revision has been added, this will be the newly added revision. | CategoryDescriptionRevision |
| getRevisionById(int $id) | Get the revision with the specified id | CategoryDescriptionRevision |
| getId() | int | |
| getName() | string | |
| getSlug() | string | |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getPublished() | DateTime | |
| isPublished() | Determines if the record is published. | bool |
| getLanguage() | Language | |
| getSite() | Site | |
| getSeoSettings() | SeoSettings | |
| getRevisions() | Collection (CategoryDescriptionRevision) | |
| isDefault() | Checks if current description is the default description of its container | bool |
| getCustomUrl() | Get the custom url used for the page. This will take precedence over the slugs of this page, parent page and the module. | CustomUrl |
| 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 |
| hasAreaWithName(string $areaName) | Check if an area with the specified name exists for the active revision of the record | bool |
| getAreaType(string $areaName) | Get the input type for the specified layout area, using the active revision of the record. 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, using the active revision of the record. 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, using the active revision of the record. 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, using the active revision of the record | Image |
| getAreaImageOrPlaceholder(string $areaName, int $width, int $height) | Get the image for the component area with the specified name. Uses the active revision of the global component. 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 |
| getAreaFile(string $areaName) | Get the file for the layout area with the specified name, using the active revision of the record | File |
| getAreaRecord(string $areaName) | Get the record for the layout area with the specified name, using the active revision of the record | Model |
| getAreaRecords(string $areaName) | Get the records for the layout area with the specified name, using the active revision of the record | Collection |
| getAreaText(string $areaName) | Get the text for the layout area with the specified name, using the active revision of the record | string |
| getAreaValues(string $areaName) | Get the values for the layout area with the specified name, using the active revision of the record | array |
| getAreaDate(string $areaName) | Get a date for the layout area with the specified name, using the active revision of the record | DateTime |
| getAreaWidget(string $areaName) | Get the widget for the layout area with the specified name, using the active revision of the record | Widget |
| getAreaComponent(string $areaName) | Get the component for the layout area with the specified name, using the active revision of the record | Component |
| getAreaCollectionElements(string $areaName) | Get the component collection elements for the layout area with the specified name, using the active revision of the record | Collection |
| getAreaHtml(string $areaName) | Get the rendered HTML for the component area with the specified name, using the active revision of the record. Adds live preview tags, if enabled. | string |
| getAreaDefaultContent(string $areaName) | Get the default content of the layout area. Uses the active revision of the global component. 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. Uses the active revision of the global component. If no default content exists, a BlankContent will be returned. | Content |
Products\Models\Frontend\CategoryDescription
CategoryDescription