ModelDocumentation module

Page

Documentation page. Can have multiple revisions and has one active revision.

A model in the Documentation module, with 35 members for templates, 28 API properties and 54 members for admin templates.

Documentation\Models\Frontend\Page Documentation\Models\Api\Page Documentation\Models\Backend\Page Also in Documentation: Comment GlobalComment GlobalCommentVote GlobalPage GlobalPageRevision PageRevision Vote

Templates view

Properties 31

Take no arguments.

# getName(): ?string; Get the name for the active revision
# getText(): ?string; Get the text for the active revision
# getParents(): array; Get the parents of this page, with this page being the last element in the array
# getOriginalFullPath(): string; Gets the original path to the documentation page without any custom URL applied, resolving the Documentation showPage route with the page's full slug
# isGlobal(): bool; Return the info that this is NOT a global documentation page
# getAssignedWorkflow(): ?Workflow; Get the workflow assigned to the record or entity
# hasAssignedWorkflow(): bool; Check whether the record has an assigned workflow
# getBranches(): Collection; Get the branches associated with the record
# getNumRevisionsWithoutBranch(): int; Get the number of revisions without branch
# getOriginalPath(): string; It's an alias and deprecated! Directly use getOriginalFullPath() instead.
# getOriginalFullSlug(): string; Gets the record's own canonical slug, built from the record's data and _ignoring_ any custom URL override. Like getFullSlug() it excludes the module path, has no leading slash, and includes ancestor slugs for hierarchical records — but it always reflects the record's real slugs rather than a custom URL. For a non-hierarchical record this equals the record's own getSlug() value. This default concatenates whatever the ancestor walk supplies and does not judge the segments: an ancestor with no slug of its own contributes an empty segment rather than failing. A model whose callers need to tell an unresolvable chain apart from a valid one should either return an empty string from an override, as Products\Models\ProductDescription does, or expose a separate check alongside it, as Pages\Models\BasePage::hasResolvableSlugChain() does.
# getFullSlug(): string; Gets the slug that addresses this record relative to its module — the portion of the URL that identifies the record itself, without the module path and without a leading slash. For a hierarchical record the slug includes the slugs of all of its ancestors joined with slashes. This is the effective slug: when a custom URL is set on the record, it _takes precedence and is returned_ here. The no-leading-slash shape describes the canonical value only. A custom URL is returned verbatim, and custom URLs are stored with a leading slash, so a record that has one returns /my-custom rather than my-custom; use getOriginalFullSlug() when you need the canonical shape unconditionally.
# getFullPath(): string; Gets the relative path that addresses this record within the site, including the module path and starting with a leading slash. This is the getFullSlug() value prefixed with the route under which the module is mounted. This is the effective path: when a custom URL is set on the record, it _takes precedence and is returned_ here. Returns an empty string when the record has no custom URL and getOriginalFullPath() cannot build one, so callers must treat an empty string as "no url" rather than as a path. Rendering it into markup or handing it to a cache or route helper would otherwise point the record at whatever the site serves at its root.
# getId(): ?int
# getPosition(): ?int
# getSlug(): ?string
# getCreated(): ?DateTime; Get the date the record was created.
# getModified(): ?DateTime; Get the last modification date for the record.
# getPublished(): ?DateTime; Get the date the record was published or is scheduled to be published.
# getActiveRevision(): ?PageRevision
# getParent(): ?Page
# getChildren(): ?Collection<Page>
# getOwner(): ?User
# isPublished(): bool; Check if the record is published.
# getRevisions(): ?Collection<PageRevision>
# getLastRevision(): ?PageRevision; Get the last revision for the entity. If a revision has been added, this will be the newly added revision.
# getComments(): ?Collection<Comment>
# getFullPosition(): string; Get the full, dot-separated full position for hierarchical records
# 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

Methods 4

Take arguments. The API serialises only getters that need none.

# getBranchRevisions(RevisionBranch $branch, ?int $limit, ?int $offset): Collection; Get the revisions for the provided branch, ordered by id ascending. Pass a limit/offset to fetch a bounded window instead of the full set — loading all revisions of a large branch exhausts memory.
# getNumBranchRevisions(RevisionBranch $branch): int; Get the number of revisions for the provided branch (COUNT query — does not hydrate)
# getRevisionsWithoutBranch(?int $limit, ?int $offset): Collection; Get the revisions without branch, ordered by id ascending. Pass a limit/offset to fetch a bounded window instead of the full set — loading all revisions of a record with a large history exhausts memory.
# getRevisionById(int $id): ?PageRevision; Get the revision with the specified id

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 28

Read-only values on the record.

# name: ?string; Get the name for the active revision
# text: ?string; Get the text for the active revision
# parents: array; Get the parents of this page, with this page being the last element in the array
# originalFullPath: string; Gets the original path to the documentation page without any custom URL applied, resolving the Documentation showPage route with the page's full slug
# global: bool; Return the info that this is NOT a global documentation page
# assignedWorkflow: ?Workflow; Get the workflow assigned to the record or entity
# assignedWorkflow: bool; Check whether the record has an assigned workflow
# branches: Collection; Get the branches associated with the record
# numRevisionsWithoutBranch: int; Get the number of revisions without branch
# originalPath: string; It's an alias and deprecated! Directly use getOriginalFullPath() instead.
# originalFullSlug: string; Gets the record's own canonical slug, built from the record's data and _ignoring_ any custom URL override. Like getFullSlug() it excludes the module path, has no leading slash, and includes ancestor slugs for hierarchical records — but it always reflects the record's real slugs rather than a custom URL. For a non-hierarchical record this equals the record's own getSlug() value. This default concatenates whatever the ancestor walk supplies and does not judge the segments: an ancestor with no slug of its own contributes an empty segment rather than failing. A model whose callers need to tell an unresolvable chain apart from a valid one should either return an empty string from an override, as Products\Models\ProductDescription does, or expose a separate check alongside it, as Pages\Models\BasePage::hasResolvableSlugChain() does.
# fullSlug: string; Gets the slug that addresses this record relative to its module — the portion of the URL that identifies the record itself, without the module path and without a leading slash. For a hierarchical record the slug includes the slugs of all of its ancestors joined with slashes. This is the effective slug: when a custom URL is set on the record, it _takes precedence and is returned_ here. The no-leading-slash shape describes the canonical value only. A custom URL is returned verbatim, and custom URLs are stored with a leading slash, so a record that has one returns /my-custom rather than my-custom; use getOriginalFullSlug() when you need the canonical shape unconditionally.
# fullPath: string; Gets the relative path that addresses this record within the site, including the module path and starting with a leading slash. This is the getFullSlug() value prefixed with the route under which the module is mounted. This is the effective path: when a custom URL is set on the record, it _takes precedence and is returned_ here. Returns an empty string when the record has no custom URL and getOriginalFullPath() cannot build one, so callers must treat an empty string as "no url" rather than as a path. Rendering it into markup or handing it to a cache or route helper would otherwise point the record at whatever the site serves at its root.
# id: ?int
# position: ?int
# slug: ?string
# created: ?DateTime; Get the date the record was created.
# modified: ?DateTime; Get the last modification date for the record.
# published: ?DateTime; Get the date the record was published or is scheduled to be published.
# activeRevision: ?PageRevision
# parent: ?Page
# children: ?Collection<Page>
# owner: ?User
# published: bool; Check if the record is published.
# revisions: ?Collection<PageRevision>
# lastRevision: ?PageRevision; Get the last revision for the entity. If a revision has been added, this will be the newly added revision.
# comments: ?Collection<Comment>
# fullPosition: string; Get the full, dot-separated full position for hierarchical records

Admin view

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

Properties 47