☰ Browse the reference

Model·Forms module

BaseElement

Element

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

Forms\Models\Frontend\BaseElementCopy Forms\Models\Api\BaseElementCopy Forms\Models\Backend\BaseElementCopy Also in Forms: ActionClass ActionFieldVisibility ActionGroupVisibility ActionRequirements ActionStepVisibility ActionUpdate BaseAction BaseCondition 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 Step StepSubmission ValidationCondition ValidationRule

View

Templates22 API & Jobs19 Admin22

What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Filter

Templates view

Properties 22

Take no arguments.

# getType()

string

Returns type for base element

# 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

# getValidationRules()

?Collection<ValidationRule>

# getValidationConditions()

?Collection<ValidationCondition>

# 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

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 19

Read-only values on the record.

# type

string

Returns type for base element

# 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

# validationRules

?Collection<ValidationRule>

# validationConditions

?Collection<ValidationCondition>

# 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 22

Take no arguments.

# getType()

string

Returns type for base element

# 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

# getValidationRules()

?Collection<ValidationRule>

# getValidationConditions()

?Collection<ValidationCondition>

# 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