Frontend | Backend | Api

Forms\Models\Frontend\BaseElement

Element

Method Description Returns
getType() Returns type for base element string
getEntity() string
getId() int
getName() Gets element name. It could be used in html to identify input, e.g. ' '. string
getHelp() Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. ' '. string
getEditor() string
getText() Text for the element that usually is used for element's label string
getDefaultValue() string
getPlaceholder() string
isRequired() bool
getRegex() string
getPosition() int
getSettings() array
getRevision() FormRevision
getStep() Step
getSubmissions() Collection (ElementSubmission)
getValidationRules() Collection (ValidationRule)
getValidationConditions() Collection (ValidationCondition)
getParent() ElementGroup
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