| 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 |
| getImageRootTargetFolderPath() | Receives the *root* target folder path for uploaded images. This is usually the root entity path without the ID or slug sub folder. | string |
| getImageTargetFolderPath() | Receives the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. | string |
| 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 |
| getAvailableLayouts() | Retrieves available layouts for showing category | Collection |
| getDefaultLanguage() | Get the default language for the record | Language |
| getAvailableLanguages() | Get the available languages | Collection |
Products\Models\Backend\CategoryDescription
CategoryDescription