| Method | Description | Returns |
|---|---|---|
| isSiteRequired() | Determine whether the site is required from the custom entity definition | bool |
| getName() | Get the name of the active revision of the record | string |
| getLayout() | Get the layout for the record revision. Since custom entity records use a layout defined on the definition level, this returns the same layout for all records of the definition. | Layout |
| getOriginalPath() | Get the original path for the record without any custom urls applied | string |
| getFullSlug() | Get the slug of the record, including the slugs of parent records | string |
| getFullPath() | Get the full path including the custom entity index | string |
| getUrl() | Get the url or path for the record. If the record belongs to a different site, this is respected in the returned url. This method will return the url using the primary environment and the primary hostname independently of the current environment the requests is viewed through. | string |
| getAllRelationships() | Get all relationships this record has, sorted by relationship definition position. One entry per definition. Also returns empty relationships for definitions where no record was linked. | Collection |
| getId() | int | |
| getSlug() | string | |
| getPosition() | int | |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getPublished() | DateTime | |
| getDefinition() | Definition | |
| getActiveRevision() | RecordRevision | |
| getParent() | Record | |
| getChildren() | Collection (Record) | |
| getLanguage() | Language | |
| getSite() | Site | |
| isPublished() | Determines if the record is published. | bool |
| getRevisions() | Collection (RecordRevision) | |
| getRelationships() | Collection (Relationship) | |
| getInverseRelationships() | Collection (Relationship) | |
| getTags() | Tags associated with the page | Collection (Tag) |
| getCategories() | Categories associated with the page | Collection (Category) |
| getRevisionById(int $id) | RecordRevision | |
| getLastRevision() | RecordRevision | |
| getCustomUrl() | Get the custom url used for the page. This will take precedence over the slugs of this page, parent page and the module. | CustomUrl |
| 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 |
| getShowFrontendUrl() | string | |
| getEditBreadcrumbs() | Get the breadcrumbs to display while editing the record | string |
| getCreateChildTypeLinks() | array | |
| 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 |
| getManageUrl() | Get the url for managing records. | string |
| getMoveUrl() | Get the url for moving the record. | string |
| getDeleteUrl() | Get the url for deleting 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 |
| getPublishUrl() | Get the url for publishing the record. | string |
| getDefaultLanguage() | Get the default language for the record | Language |
| getAvailableLanguages() | Get the available languages | Collection |
CustomEntities\Models\Backend\Record
Record