| getParent() |
Get the parent of the book. Will always return null. |
Book
|
| getUnitsCount() |
Get the number of units in this book |
int
|
| getPagesCount() |
Get the number of pages in this book |
int
|
| getExportPdfPath() |
Get the path of the export pdf associated with the book |
string
|
| getExportPdfStatus() |
Get a translated PDF export status |
string
|
| getExportPdfDate() |
Retrieve the date the PDF was exported. Will return the date null if no PDF exists |
DateTime
|
| getUnits() |
Get the units of the book |
Collection
|
| getCustomFieldValues() |
|
Collection (BookCustomFieldValue)
|
| 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
|
| getFullPath() |
Get the full path including the module route name |
string
|
| getOriginalPath() |
Get the original path for the page without any custom urls applied |
string
|
| getImageRootTargetFolderPath() |
Retrieves the *root* target folder path for uploaded images. This is usually the root entity path without the ID or slug sub folder. |
string
|
| getImageTargetFolderPath() |
Retrieves the target folder path for uploaded images. Images will be moved to this path after the upload has been processed. |
string
|
| isSupportingBranches() |
Checks whether the record supports branches |
bool
|
| getAssignedWorkflow() |
Get the workflow assigned to the record or entity |
Workflow
|
| hasAssignedWorkflow() |
Check whether the record has an assigned workflow |
bool
|
| getBranches() |
Get the branches associated with the record |
Collection
|
| getBranchRevisions(RevisionBranch $branch) |
Get the revisions for the provided branch |
Collection
|
| getNumRevisionsWithoutBranch() |
Get the number of revisions without branch |
int
|
| getRevisionsWithoutBranch() |
Get all revisions without branch |
Collection
|
| 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 last revision for the page |
PageRevision
|
| getLanguage() |
The language for the page |
Language
|
| getChildren() |
Child pages, i.e. pages located underneath this page |
Collection (Unit)
|
| getRevisions() |
Revisions for the page |
Collection (PageRevision)
|
| getTags() |
Tags associated with the page |
Collection (Tag)
|
| getCategories() |
Categories associated with the page |
Collection (Category)
|
| 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
|
| isVersionedModel() |
Check whether a model is versioned |
bool
|
| getFullPosition() |
Get the full, dot-separated full position for hierarchical records |
string
|
| getHateoasLinks() |
Get the HATEOAS links for the record |
array
|
| getCreateChildUrl() |
Get the url for creating a child record. |
string
|
| getEditUrl() |
Get the url for editing 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
|