g
Frontend | Backend | Api

Books\Models\Frontend\Page

Method Description Returns
getPositionInBook() Get the position of the page in the whole book => the page number Returns null if no book is set for the page int
getFullPath() Get the full path including the module route name string
getUnit() Get the unit for this page Unit
getCustomFieldValues() Collection (PageCustomFieldValue)
getCustomFieldValue(CustomField $customField) Get the value for a custom field CustomFieldValue
getCustomFieldValueByName(string $customFieldName) Get the value for a custom field by the custom field name CustomFieldValue
getCustomFieldContent(string $customFieldName) Get the content for the custom field identified by the specified name Content
getCustomFieldContentOrDefault(string $customFieldName) Get the content (or default content) for the custom field identified by the specified name Content
getCustomFieldBoolean(string $customFieldName, ?bool|null $default) Get the (default) content of the custom field as boolean value bool
getCustomFieldText(string $customFieldName, ?string|null $default) Get the (default) content of the custom field as text string
getCustomFieldImage(string $customFieldName) Get the (default) image contained in the custom field Image
getCustomFieldFile(string $customFieldName) Get the (default) file contained in the custom field File
getCustomFields() Get the custom fields for this entity array
hasCustomField(string $customFieldName) Check if the entity has a custom field with the specified name bool
getName() Get the name for the active revision string
getFullSlug() Get the slug of the page, including the slugs of parent pages string
getOriginalPath() Get the original path for the page without any custom urls applied string
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() The ID of the page int
getSlug() The slug for the page, i.e. the url portion identifying the page. Does not include parent slugs or the module slug. string
getPublishAt() Date at which the page will be published or has been published DateTime
getUnpublishAt() Date after which the page should not be shown anymore DateTime
getPosition() Position of the page in the list of pages at the same level (i.e. with the same parent) int
getCreated() Date at which the page was created DateTime
getModified() Date at which the page was last modified DateTime
getPublished() Date at which the page was published DateTime
getSite() Site associated with the page Site
getActiveRevision() The active revision for the page PageRevision
getLastRevision() The the last revision for the page PageRevision
getLanguage() The language for the page Language
getRevisions() Revisions for the page Collection (PageRevision)
getTags() Tags associated with the page Collection (Tag)
getCategories() Categories associated with the page Collection (Category)
getAdminComments() Admin comments for the page, i.e. comments that should only be displayed to backend users Collection (PageAdminComment)
isPublished() Determines if the record is published bool
getOwner() The owner of the page, possibly having different access rights to the page User
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
getAreaType(string $areaName) Get the input type for the specified layout area, using the active revision of the record. Returns null if the area with the specified name could not be found. InputType
getAreaCategory(string $areaName) Get the category for the specified layout area, using the active revision of the record. Returns null if the area with the specified name could not be found. string
getAreaEditor(string $areaName) Get the editor for the specified layout area, using the active revision of the record. Returns null if the area with the specified name could not be found. string
getAreaImage(string $areaName) Get the image for the layout area with the specified name, using the active revision of the record Image
getAreaImageOrPlaceholder(string $areaName, int $width, int $height) Get the image for the component area with the specified name. Uses the active revision of the global component. If the image does not exist, get a placeholder image with the specified dimensions Will always return an image, even if it was not found (in that case, an empty image). Image
getAreaFile(string $areaName) Get the file for the layout area with the specified name, using the active revision of the record Image
getAreaRecord(string $areaName) Get the record for the layout area with the specified name, using the active revision of the record Model
getAreaRecords(string $areaName) Get the records for the layout area with the specified name, using the active revision of the record Collection
getAreaText(string $areaName) Get the text for the layout area with the specified name, using the active revision of the record string
getAreaValues(string $areaName) Get the values for the layout area with the specified name, using the active revision of the record array
getAreaDate(string $areaName) Get a date for the layout area with the specified name, using the active revision of the record DateTime
getAreaWidget(string $areaName) Get the widget for the layout area with the specified name, using the active revision of the record Widget
getAreaComponent(string $areaName) Get the component for the layout area with the specified name, using the active revision of the record Component
getAreaCollectionElements(string $areaName) Get the component collection elements for the layout area with the specified name, using the active revision of the record Collection
getAreaHtml(string $areaName) Get the rendered HTML for the component area with the specified name, using the active revision of the record. Adds live preview tags, if enabled. string
getAreaDefaultContent(string $areaName) Get the default content of the layout area. Uses the active revision of the global component. Will return a BlankContent if no content was defined. Content
getAreaContentOrDefault(string $areaName) Get the content of the layout area, or the default content if no content exists. Uses the active revision of the global component. If no default content exists, a BlankContent will be returned. Content