| Method | Description | Returns |
|---|---|---|
| getRevisionById(int $id) | Get a revision with the provided id | DocumentationPageRevision |
| 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() | Get the slug prefixed with a slash and including the slugs of parent pages | string |
| getFullPath() | Get the full path including the module route name | string |
| isGlobal() | Return the info that this is 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() | DateTime | |
| getActiveRevision() | DocumentationPageRevision | |
| getParent() | DocumentationPage | |
| isPublished() | Check if the record is published. | bool |
| getRevisions() | Collection (DocumentationPageRevision) | |
| getChildren() | Collection (DocumentationPage) | |
| getComments() | Collection (DocumentationPageComment) | |
| 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 |
| getAvailableParents() | Get the available parents for this page. Only fetches pages that aren't the current page. | Collection |
| 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 |
| getDeleteUrl() | Get the url for deleting the record. | string |
| getPermissionsUrl() | Get the url for editing the permissions of the record. | string |
| getPublishUrl() | Get the url for publishing the record. | string |
| getManageUrl() | Get the url for managing records. | string |
Globals\Models\Backend\DocumentationPage
DocumentationPage