g
Frontend | Backend | Api

Pages\Models\Backend\Page

Page

Method Description Returns
getParent() Get the parent for the page Page
getFullSlug() Get the slug of the page, including the slugs of parent pages string
getFullPath() Get the full path including the module route name 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
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
getName() Get the name for the active revision string
getOriginalPath() Get the original path for the page without any custom urls applied string
getImageTargetFolderPath() Get the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. string
getImageSelectorStartPath() Get the start folder for browsing images related to this record using the file manager string
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
getLastRevision() The last revision for the page PageRevision
getLanguage() The language for the page Language
getChildren() Child pages, i.e. pages located underneath this page Collection (Page)
getRevisions() Revisions for the page Collection (PageRevision)
getTags() Tags associated with the page Collection (Tag)
getCategories() Categories associated with the page Collection (Category)
getAdminComments() Admin comments for the page, i.e. comments that should only be displayed to backend users Collection (PageAdminComment)
isPublished() Determines if the record is published bool
getOwner() The owner of the page, possibly having different access rights to the page User
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
getFullPosition() Get the full, dot-separated full position for hierarchical records string
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