| Method | Description | Returns |
|---|---|---|
| isActiveRevision() | Check if the revision is the active revision | bool |
| getSuccessRedirectTarget() | Gets success redirect target from settings | string |
| getSuccessRedirectMethod() | Gets success redirect method from settings: get, post, put | string |
| hasRequireCompletedCaptcha() | Returns if completed captcha (when such input exists) is required to save the submission. If there is a captcha input among submitted steps, every of such has to be completed. Otherwise, the form submission will not be saved. The setting is not used when there is no captcha input. | bool |
| getAreas() | Collection | |
| getAreaGroups() | Gets the layout area groups | Collection |
| getAreaContent(string $areaName) | Get the content of the layout area | Content |
| getAreaDefaultContent(string $areaName) | Get the default content of the layout area | Content |
| getAreaContentOrDefault(string $areaName) | Get the content of the layout area, or the default content if no content exists | Content |
| getAreaAttributesContent(string $areaName) | Gets the content of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getAreaAttributesDefaultContent(string $areaName) | Gets the default content of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getAreaAttributesContentOrDefault(string $areaName) | Gets the content (or the default content if no content exists) of every layout area attribute. If layout area does not have attributes, returns empty array. | array |
| getEntityAreaByLayoutArea(LayoutArea $area) | Get the link record between the layout area and content for the designated layout area | Model |
| hasAreaWithName(string $areaName) | Check if an area with the specified name exists for the container | bool |
| getAreaType(string $areaName) | Get the input type for the specified layout area. 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. 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. 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 | Image |
| getAreaFile(string $areaName) | Get the file for the layout area with the specified name | File |
| getAreaRecord(string $areaName) | Get the record for the layout area with the specified name | Model |
| getAreaRecords(string $areaName) | Get the records for the layout area with the specified name | Collection |
| getAreaText(string $areaName) | Get the text for the layout area with the specified name | string |
| getAreaValues(string $areaName) | Get the values for the layout area with the specified name | array |
| getAreaDate(string $areaName) | Get a date for the layout area with the specified name | DateTime |
| getAreaWidget(string $areaName) | Get the widget for the layout area with the specified name | Widget |
| getAreaComponent(string $areaName) | Get the component for the layout area with the specified name | Component |
| getAreaCollectionElements(string $areaName) | Get the component collection elements for the layout area with the specified name | Collection |
| getAreaHtml(string $areaName) | Get the rendered HTML for the component area with the specified name. Adds live preview tags, if enabled. | string |
| getId() | int | |
| getType() | string | |
| getCreated() | Date the record was created. | DateTime |
| getModified() | Last modification date for the record. | DateTime |
| getForm() | Form | |
| getLayout() | Layout | |
| getBranch() | RevisionBranch | |
| getCreatedBy() | User | |
| getModifiedBy() | User | |
| getSubmissions() | Collection (FormSubmission) | |
| getSteps() | Collection (Step) | |
| getElements() | Collection (BaseElement) | |
| getSettings() | array | |
| getFormAreas() | Collection (FormArea) | |
| 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 |
Forms\Models\Backend\FormRevision
FormRevision