g
Frontend | Backend | Api

Books\Models\Backend\Page

Method Description Returns
getParent() Get the unit for the page Unit
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
getChildren() Child pages, i.e. pages located underneath this page Collection (Page)
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
getAvailableUnitNames() Get the available tags array
getAvailableLayouts() Get the available layouts for showing pages Collection
getHateoasLinks() Get the HATEOAS links for the record array
getEditUrl() Get the url for editing the record. string
getExportPdfUrl() Get the url for exporting a pdf for the record. string
getMoveUrl() Get the url for moving the record. string
getDeleteUrl() Get the url for deleting the record. string
getPublishUrl() Get the url for publishing the record. string
getPermissionsUrl() Get the url for editing the permissions of the record. string
getCheckPermissionsUrl() Get the url for checking user permissions for this record. string