g
Frontend | Backend | Api

Documentation\Models\Backend\Page

Documentation page. Can have multiple revisions and has one active revision.

Method Description Returns
getName() Get the name for the active revision string
getText() Get the text for the active revision string
getParents() Get the parents of this page, with this page being the last element in the array array
getFullSlug() string
getFullPath() string
getOriginalPath() string
isGlobal() Return the info that this is NOT a global documentation page bool
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() int
getPosition() int
getSlug() string
getCreated() Get the date the record was created. DateTime
getModified() Get the last modification date for the record. DateTime
getPublished() Get the date the record was published or is scheduled to be published. DateTime
getActiveRevision() PageRevision
getRevisionById(int $id) Get the revision with the specified id PageRevision
getParent() Page
getChildren() Collection (Page)
getOwner() User
isPublished() Check if the record is published. bool
getRevisions() Collection (PageRevision)
getLastRevision() Get the last revision for the entity. If a revision has been added, this will be the newly added revision. PageRevision
getComments() Collection (Comment)
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
getShowPagePath() Get the path for showing the page in the frontend string
getCommentsCount() Get the number of comments for this page. int
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
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
getManageUrl() Get the url for managing records. string
getDuplicateUrl() Get the url for duplicating the record. string