ModelForms module

InputSlider

Entity for <input type="range">.
It was decided to call class Slider, not Range, because <input type="range"> looks like slider and range sounds like something to save two values: from and to.

A model in the Forms module, with 31 members for templates, 24 API properties and 29 members for admin templates.

Forms\Models\Frontend\InputSlider Forms\Models\Api\InputSlider Forms\Models\Backend\InputSlider 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 InputSubmitButton InputTel InputText InputTextarea PaymentElement StaticCode StaticElement StaticRichtext StaticSubmitButton Step StepSubmission ValidationCondition ValidationRule

Templates view

Properties 29

Take no arguments.

# __toString() Templates only: string; Get a string representation of the element => render the output html
# getType(): string; Returns the type of the current element.
# getMinValue(): ?float
# getMaxValue(): ?float
# isCurrentlyRequired(): bool; Returns element current required option used in validation
# getStepValue(): ?float; Returns step setting value. Returns null if setting is not set, step set to 0 or less or setting is set incorrect Returns always float (event if it's an int) value for number inputs.
# getErrors(): ?array; Gets all violations (error messages) related to the element's current submission
# getErrorMessage(): string; Gets error message for the field. If there are several errors for the element, all of them will be added to this message.
# hasErrors(): bool; Returns whether element has at least one error
# getName(): ?string
# getEntity(): ?string
# getId(): ?int
# 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; Renders html for input element. Block tag: div.base-element-block.input-element-block Label: label.element-label.element-text Input: input|textArea|select.element-input.{editor: inputText, inputEmail, inputSelect and so on} Validation: div.input-element-validation-errors.invalid-feedback

Methods 2

Take arguments. The API serialises only getters that need none.

# getValue(ElementSubmission $submission): ?string; Gets string representation of given submission value. By default, returns values from submission values array (via [[getValues()]] method) imploded by ', '. That is suitable for most of the inputs. For example, InputText is always filled by one value in array, so only one value will be returned. For InputSelect it's ok to use current method if select is not (or was not when was submitted) multiple. If InputSelect (or similar) is multiple, and you use current method, if there is a ',' sing in submitted values, it could be difficult to explode current string then. That's why if InputSelect is "multiple" it's better to use [[getValues()]] method instead. NOTE that submission validness isn't checked here.
# getValues(ElementSubmission $submission): ?array; Gets array representation of given submission value even if it's one value array. By default, returns submission values array. Returns null if values are not set at all. NOTE that submission validness isn't checked here.

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 24

Read-only values on the record.

# type: string; Returns the type of the current element.
# minValue: ?float
# maxValue: ?float
# currentlyRequired: bool; Returns element current required option used in validation
# stepValue: ?float; Returns step setting value. Returns null if setting is not set, step set to 0 or less or setting is set incorrect Returns always float (event if it's an int) value for number inputs.
# errors: ?array; Gets all violations (error messages) related to the element's current submission
# errorMessage: string; Gets error message for the field. If there are several errors for the element, all of them will be added to this message.
# errors: bool; Returns whether element has at least one error
# name: ?string
# entity: ?string
# id: ?int
# 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 27

Take no arguments.

# getType(): string; Returns the type of the current element.
# getMinValue(): ?float
# getMaxValue(): ?float
# isCurrentlyRequired(): bool; Returns element current required option used in validation
# getStepValue(): ?float; Returns step setting value. Returns null if setting is not set, step set to 0 or less or setting is set incorrect Returns always float (event if it's an int) value for number inputs.
# getErrors(): ?array; Gets all violations (error messages) related to the element's current submission
# getErrorMessage(): string; Gets error message for the field. If there are several errors for the element, all of them will be added to this message.
# hasErrors(): bool; Returns whether element has at least one error
# getName(): ?string
# getEntity(): ?string
# getId(): ?int
# 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

Methods 2

Take arguments. The API serialises only getters that need none.

# getValue(ElementSubmission $submission): ?string; Gets string representation of given submission value. By default, returns values from submission values array (via [[getValues()]] method) imploded by ', '. That is suitable for most of the inputs. For example, InputText is always filled by one value in array, so only one value will be returned. For InputSelect it's ok to use current method if select is not (or was not when was submitted) multiple. If InputSelect (or similar) is multiple, and you use current method, if there is a ',' sing in submitted values, it could be difficult to explode current string then. That's why if InputSelect is "multiple" it's better to use [[getValues()]] method instead. NOTE that submission validness isn't checked here.
# getValues(ElementSubmission $submission): ?array; Gets array representation of given submission value even if it's one value array. By default, returns submission values array. Returns null if values are not set at all. NOTE that submission validness isn't checked here.

Objects ReferenceGenerated from the platform, so it is always current

API ReferenceEvery REST endpoint, in cURL, PHP, Python and JavaScript

InputSlider

Templates view

Properties 29

Methods 2

API & Jobs view

Properties 24

Admin view

Properties 27

Methods 2