ModelDocumentation module

GlobalPageRevision

DocumentationPageRevision

A model in the Documentation module, with 13 members for templates, 10 API properties and 14 members for admin templates.

Documentation\Models\Frontend\GlobalPageRevision Documentation\Models\Api\GlobalPageRevision Documentation\Models\Backend\GlobalPageRevision Also in Documentation: Comment GlobalComment GlobalCommentVote GlobalPage Page PageRevision Vote
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 13

Take no arguments.

# isActiveRevision()
bool
Check if the revision is the active revision
# getGlobalPage()
?GlobalPage
Get global page
# getId()
?int
# getType()
?string
# getName()
?string
# getText()
?string
Get the text for the PageRevision. Ensures configured formatting rules are applied.
# getEditor()
?string
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# getPage()
?GlobalPage
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 10

Read-only values on the record.

# activeRevision
bool
Check if the revision is the active revision
# globalPage
?GlobalPage
Get global page
# id
?int
# type
?string
# name
?string
# text
?string
# editor
?string
# created
?DateTime
Get the date the record was created.
# modified
?DateTime
Get the last modification date for the record.
# page
?GlobalPage

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 14

Take no arguments.

# isActiveRevision()
bool
Check if the revision is the active revision
# getGlobalPage()
?GlobalPage
Get global page
# getId()
?int
# getType()
?string
# getName()
?string
# getText()
?string
# getEditor()
?string
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# getPage()
?GlobalPage
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getCreatedBy() Admin only
Global Page Revisions don't have an author. Custom getter for the revision block in the sidebar.