| Method | Description | Returns |
|---|---|---|
| getOriginalPath() | Get the original path for the product description 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() | Retrieves the *root* target folder path for uploaded images. This is usually the root entity path without the ID or slug sub folder. | string |
| getImageTargetFolderPath() | Retrieves the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. | string |
| isSupportingBranches() | Checks whether the record supports branches | bool |
| 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 |
| getText() | string | |
| getActiveRevision() | ProductDescriptionRevision | |
| getProduct() | BaseProduct | |
| getContainer() | Returns the product as the container of the description | BaseProduct |
| getTags() | Collection (Tag) | |
| getLastRevision() | Get the last revision for the entity. If a revision has been added, this will be the newly added revision. | ProductDescriptionRevision |
| getRevisionById(int $id) | Get the revision with the specified id | ProductDescriptionRevision |
| 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 (ProductDescriptionRevision) | |
| 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 |
| getHateoasLinks() | Force product descriptions to use its products' HATEOAS links | array |
| getAvailableLayouts() | Get the available layouts for showing products | Collection |
| getCreateChildUrl() | Get the url for creating a child record. | string |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getEditUrl() | Get the url for editing the record. | string |
| getMoveUrl() | Get the url for moving the record. | string |
| getPermissionsUrl() | Get the url for editing the permissions of the record. | string |
| getCheckPermissionsUrl() | Get the url for checking user permissions for this record. | string |
| getPublishUrl() | Get the url for publishing the record. | string |
| getShowFrontendUrl() | Get the url showing the record in the frontend | string |
| getDefaultLanguage() | Get the default language for the record | Language |
| getAvailableLanguages() | Get the available languages | Collection |
| getAvailableSaveActions(?Coredna\Kernel\Models\Model|null $currentRevision) | Get the save actions available for the record and provided revision being edited | array |
| getAvailableSaveNewActions() | Get the actions available for saving a new version of the record. Determined whether an active revision can be set directly, and in which order the actions should be returned. | array |
| getRevisionActions(Coredna\Kernel\Models\Model $revision, ?Coredna\Kernel\Models\Model|null $currentRevision) | Get the actions available for the provided revision | array |
| getUpdateRevisionId(Coredna\Kernel\Models\Revision $revision) | Get the revision ID to use when updating the record. If the provided revision is a draft, the previous id is returned, if one exists. | int |
Products\Models\Backend\ProductDescription
ProductDescription