ModelDocumentation module

PageRevision

ContentRevision

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

Documentation\Models\Frontend\PageRevision Documentation\Models\Api\PageRevision Documentation\Models\Backend\PageRevision Also in Documentation: Comment GlobalComment GlobalCommentVote GlobalPage GlobalPageRevision Page 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 14

Take no arguments.

# isActiveRevision()
bool
Check if the revision is the active revision
# getText()
?string
Get the text for the PageRevision. Ensures configured formatting rules are applied.
# getId()
?int
# getType()
?string
# getEditor()
?string
# getName()
?string
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# getCreatedBy()
?User
# getModifiedBy()
?User
# getPage()
?Page
# 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 11

Read-only values on the record.

# activeRevision
bool
Check if the revision is the active revision
# text
?string
Get the text for this page revision. Also parses image and link placeholders in the process.
# id
?int
# type
?string
# editor
?string
# name
?string
# created
?DateTime
Get the date the record was created.
# modified
?DateTime
Get the last modification date for the record.
# createdBy
?User
# modifiedBy
?User
# page
?Page

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
# getText()
?string
Get the text for this page revision. Also parses image and link placeholders in the process.
# getId()
?int
# getType()
?string
# getEditor()
?string
# getName()
?string
# getCreated()
?DateTime
Get the date the record was created.
# getModified()
?DateTime
Get the last modification date for the record.
# getCreatedBy()
?User
# getModifiedBy()
?User
# getPage()
?Page
# 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