ModelForms module

StaticElement

Base static element class.
Static element could be code, image, RichText, etc. For every such element we have separated Static{elementName} class extended from this one.

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

Forms\Models\Frontend\StaticElement Forms\Models\Api\StaticElement Forms\Models\Backend\StaticElement 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 StaticRichtext StaticSubmitButton Step StepSubmission ValidationCondition ValidationRule

Templates view

Properties 23

Take no arguments.

# __toString() Templates only: string; Get a string representation of the element => render the output html
# getChildren(): Collection
# getType(): string
# getEntity(): ?string
# getId(): ?int
# getName(): ?string; Gets element name. It could be used in html to identify input, e.g. '<input name="{getName()}" ...>'.
# getHelp(): ?string; Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. '<input title="{getHelp()}" ...>'.
# getEditor(): ?string
# getText(): ?string; Text for the element that usually is used for element's label
# getDefaultValue(): ?string
# getPlaceholder(): ?string
# isRequired(): ?bool
# getRegex(): ?string
# getPosition(): ?int
# getSettings(): ?array
# getRevision(): ?FormRevision
# getStep(): ?Step
# getParent(): ?ElementGroup
# getElementId(): ?string
# 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
# getHtml() Templates only: string

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 18

Read-only values on the record.

# children: Collection
# type: string
# entity: ?string
# id: ?int
# name: ?string; Gets element name. It could be used in html to identify input, e.g. '<input name="{getName()}" ...>'.
# help: ?string; Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. '<input title="{getHelp()}" ...>'.
# editor: ?string
# text: ?string; Text for the element that usually is used for element's label
# defaultValue: ?string
# placeholder: ?string
# required: ?bool
# regex: ?string
# position: ?int
# settings: ?array
# revision: ?FormRevision
# step: ?Step
# parent: ?ElementGroup
# elementId: ?string

Admin view

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

Properties 21