ModelForms module

Step

A model in the Forms module, with 14 members for templates, 11 API properties and 14 members for admin templates.

Forms\Models\Frontend\Step Forms\Models\Api\Step Forms\Models\Backend\Step Also in Forms: ActionClass ActionFieldVisibility ActionGroupVisibility ActionRequirements ActionStepVisibility ActionUpdate BaseAction BaseCondition BaseElement ConditionDate ConditionMatch ConditionNumeric ConditionString ConditionValue Conditional ElementGroup ElementSubmission Form FormArea FormCustomFieldValue FormRevision FormSubmission InputCaptcha InputCheckbox InputDatetime InputElement InputEmail InputFile InputHidden InputNumber InputRadio InputRange InputSelect InputSlider InputSubmitButton InputTel InputText InputTextarea PaymentElement StaticCode StaticElement StaticRichtext StaticSubmitButton StepSubmission ValidationCondition ValidationRule
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 14

Take no arguments.

# hasFileInput()
bool
Returns whether current step has InputFile. This method can be used to decide whether to add enctype="multipart/form-data" to form.
# getSubmissionsCount()
int
Get the number of submissions for this step
# getId()
?int
# getType()
?string
# getName()
?string
# getPosition()
?int
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getRevision()
?FormRevision
# getElements()
?Collection<BaseElement>
# getSettings()
?array
# 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

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 11

Read-only values on the record.

# fileInput
bool
Returns whether current step has InputFile. This method can be used to decide whether to add enctype="multipart/form-data" to form.
# submissionsCount
int
Get the number of submissions for this step
# id
?int
# type
?string
# name
?string
# position
?int
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# revision
?FormRevision
# elements
?Collection<BaseElement>
# settings
?array

Admin view

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

Properties 14

Take no arguments.

# hasFileInput()
bool
Returns whether current step has InputFile. This method can be used to decide whether to add enctype="multipart/form-data" to form.
# getSubmissionsCount()
int
Get the number of submissions for this step
# getId()
?int
# getType()
?string
# getName()
?string
# getPosition()
?int
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getRevision()
?FormRevision
# getElements()
?Collection<BaseElement>
# getSettings()
?array
# 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