ModelForms module

FormSubmission

A model in the Forms module, with 16 members for templates, 17 API properties and 18 members for admin templates.

Forms\Models\Frontend\FormSubmission Forms\Models\Api\FormSubmission Forms\Models\Backend\FormSubmission Also in Forms: ActionClass ActionFieldVisibility ActionGroupVisibility ActionRequirements ActionStepVisibility ActionUpdate BaseAction BaseCondition BaseElement ConditionDate ConditionMatch ConditionNumeric ConditionString ConditionValue Conditional ElementGroup ElementSubmission Form FormArea FormCustomFieldValue FormRevision InputCaptcha InputCheckbox InputDatetime InputElement InputEmail InputFile InputHidden InputNumber InputRadio InputRange InputSelect InputSlider InputSubmitButton InputTel InputText InputTextarea PaymentElement StaticCode StaticElement StaticRichtext StaticSubmitButton Step StepSubmission ValidationCondition ValidationRule

Templates view

Properties 16

Take no arguments.

# getId(): ?int
# getToken(): ?string
# getCompleted(): ?DateTime
# getCreated(): ?DateTime; Date the record was created.
# getModified(): ?DateTime; Last modification date for the record.
# getSite(): ?Site
# getRevision(): ?FormRevision
# getForm(): ?Form
# getCreatedBy(): ?User
# getModifiedBy(): ?User
# getStepSubmissions(): ?Collection<StepSubmission>
# getElementSubmissions(): ?Collection<ElementSubmission>
# isNewRecord() Not in API & Jobs: bool; Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs: bool; Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs: bool; Check whether a model is versioned
# getRedirectData() Templates only: array; Gets array data for submitted elements to use it for GET redirection. It could be used for creating URL with submitted elements. Method does not check if redirecting for the form is allowed, it only provides required data.

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 17

Read-only values on the record.

# hateoasLinks Not in Templates: array; Get the HATEOAS links for the record
# showUrl Not in Templates: ?string; Get the url for exporting a pdf for the record.
# deleteUrl Not in Templates: ?string; Get the url for deleting the record.
# id: ?int
# token: ?string
# completed: ?DateTime
# created: ?DateTime; Date the record was created.
# modified: ?DateTime; Last modification date for the record.
# site: ?Site
# revision: ?FormRevision
# form: ?Form
# createdBy: ?User
# modifiedBy: ?User
# stepSubmissions: ?Collection<StepSubmission>
# elementSubmissions: ?Collection<ElementSubmission>
# data API & Jobs only: array; Gets data by key => value for every submitted element of this form. Value could be either a string or an array.
# result API & Jobs only: array; Retrieves the result of the form submission based on the active revision's settings. This function processes the form's submission action and returns the appropriate result. It handles two actions: 1. If the action is 'showResultStep', it gathers all the text elements from the result steps. 2. Otherwise, it returns a redirection URL if configured.

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 18