| Method | Description | Returns |
|---|---|---|
| getParent() | Get the parent for the page | Page |
| getImageRootTargetFolderPath() | Retrieves the root target folder path for uploaded images. | string |
| getUrl() | Get the url or path for a page. If the page belongs to a different site, this is respected in the returned url. This method will return the url using the primary environment and the primary hostname independently of the current environment the requests is viewed through. | string |
| getDuplicateUrl() | Builds the URL to duplicate record. Does not get the URL for the main (homepage) record. | string |
| getHateoasLinks() | Get the HATEOAS links for the record | array |
| getCreateChildUrl() | Get the url for creating a child record. | string |
| getEditUrl() | Get the url for editing the record. | string |
| getMoveUrl() | Get the url for moving the record. | string |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getPublishUrl() | Get the url for publishing the record. | string |
| getManageUrl() | Get the url for managing records. | 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 |
| getShowFrontendUrl() | Get the url showing the record in the frontend | string |
| getSourcePage() | The source page this page was translated from | Page |
| getRelatedPages() | The pages this page has been translated to | Collection (Page) |
| getSeoSettings() | The SEO settings for the page, like title, descriptions, robots and keywords | SeoSettings |
| getName() | Get the name for the active revision | string |
| getFullSlug() | Gets the slug including the slugs of parent entities. If there is a custom URL, it is returned instead. | string |
| getFullPath() | Gets the full path including the module route name. If there is a custom URL, it is returned instead. | string |
| getOriginalPath() | Gets the original path for the entity without any custom URL applied | 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 |
| getId() | The ID of the page | int |
| getSlug() | The slug for the page, i.e. the url portion identifying the page. Does not include parent slugs or the module slug. | string |
| getPublishAt() | Date at which the page will be published or has been published | DateTime |
| getUnpublishAt() | Date after which the page should not be shown anymore | DateTime |
| getPosition() | Position of the page in the list of pages at the same level (i.e. with the same parent) | int |
| getCreated() | Date at which the page was created | DateTime |
| getModified() | Date at which the page was last modified | DateTime |
| getPublished() | Date at which the page was published | DateTime |
| getSite() | Site associated with the page | Site |
| getActiveRevision() | The active revision for the page | PageRevision |
| getRevisionById(int $id) | Get the revision with the specified id | PageRevision |
| getChildren() | Child pages, i.e. pages located underneath this page | Collection (Page) |
| getRevisions() | Revisions for the page | Collection (PageRevision) |
| getLastRevision() | Get the last revision for the entity. If a revision has been added, this will be the newly added revision. | PageRevision |
| getTags() | Tags associated with the page | Collection (Tag) |
| getCategories() | Categories associated with the page | Collection (Category) |
| isPublished() | Determines if the record is published. | bool |
| getOwner() | The owner of the page, possibly having different access rights to the page. | User |
| getLanguage() | The language for the page | Language |
| 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 |
| getFullPosition() | Get the full, dot-separated full position for hierarchical records | string |
| 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 |
| getAvailableSites() | Fetches the available sites. Returns all sites that are not already assigned to a page, unless it is the current page | Collection |
| getAvailableLayouts() | Get the available layouts for showing pages | Collection |
| getAvailableUsers() | Get the available users | Collection |
| getDisplayProperty() | Get the display property to use | string |
| getDisplaySlug() | Get the slug to display in the backend. Returns the site's primary hostname for homepages. | string |
| 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\Revision $revision, ?Coredna\Kernel\Models\Revision|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 |
Pages\Models\Backend\Page
Page