Frontend | Backend | Api

Documentation\Models\Backend\GlobalPage

GlobalPage

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 a global documentation page bool
getCommentsCount() Get the number of comments for this page. int
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
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() DateTime
getActiveRevision() GlobalPageRevision
getRevisionById(int $id) Get the revision with the specified id GlobalPageRevision
getParent() GlobalPage
isPublished() Check if the record is published. bool
getRevisions() Collection
getLastRevision() Get the last revision for the entity. If a revision has been added, this will be the newly added revision. GlobalPageRevision
getChildren() Collection
getComments() Collection
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
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
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