Property | Description | Returns |
---|---|---|
name | Get the name for the active revision | string |
text | Get the text for the active revision | string |
parents | Get the parents of this page, with this page being the last element in the array | array |
fullSlug | Get the slug prefixed with a slash and including the slugs of parent pages | string |
fullPath | Get the full path including the module route name | string |
global | Return the info that this is a global documentation page | bool |
imageTargetFolderPath | Get the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. | string |
imageSelectorStartPath | Get the start folder for browsing images related to this record using the file manager | string |
id | int | |
position | int | |
slug | string | |
created | Get the date the record was created. | DateTime |
modified | Get the last modification date for the record. | DateTime |
published | DateTime | |
activeRevision | DocumentationPageRevision | |
parent | DocumentationPage | |
published | Check if the record is published. | bool |
revisions | Collection (DocumentationPageRevision) | |
children | Collection (DocumentationPage) | |
comments | Collection (DocumentationPageComment) | |
newRecord | Check if the record is a new record | bool |
hierarchicalModel | Check whether a model is a hierarchical model, i.e. can have children | bool |
Globals\Models\Api\DocumentationPage
DocumentationPage