Method | Description | Returns |
---|---|---|
getAvailableLayouts() | Get the available layouts for showing forms | Collection |
getCurrentSubmission() | Get the current form submission | FormSubmission |
hasFileInput() | Returns whether form has InputFile at any step. This method can be used to decide whether to add `enctype="multipart/form-data"` to form. | bool |
getSteps() | Get the steps for the active revision of the form. Returns null if the form does not have an active revision. | Collection |
getElements() | Get the elements for the active revision of the form. Returns null if the form does not have an active revision. | Collection |
getId() | int | |
getName() | string | |
getIdentifier() | string | |
getCreated() | Date the record was created. | DateTime |
getModified() | Last modification date for the record. | DateTime |
getPublished() | DateTime | |
getSite() | Site | |
getActiveRevision() | FormRevision | |
isPublished() | Determines if the record is published. | bool |
getRevisions() | Collection (FormRevision) | |
getSubmissions() | Collection (FormSubmission) | |
getRevisionById(int $id) | Model | |
getLastRevision() | Model | |
getCustomFieldValues() | Collection (FormCustomFieldValue) | |
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 |
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 |
getTotalSubmissionsCount() | Get the total number of form submissions. In the backend, this is calculated on the fly based on user access permissions. | int |
getUniqueInputElements() | Returns unique by name input elements of this model. Returns all elements through all revisions. | Collection |
getHateoasLinks() | Get the HATEOAS links for the record | array |
getEditUrl() | Get the url for editing the record. | string |
getDeleteUrl() | Get the url for deleting the record. | string |
getDuplicateUrl() | Get the url for duplicating 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 |
Forms\Models\Backend\Form
Form