ModelForms module

InputFile

Entity for <input type="file">.

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

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

Templates view

Properties 26

Take no arguments.

# getType(): string; Returns the type of the current element.
# isMultiple(): bool; Returns whether multiple value is set.
# isCurrentlyRequired(): bool; Returns element current required option used in validation
# 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. Imploded every array of each submitted file data by ', ' and such arrays between each other by '; '. It's not recommended to use this method if file input is multiple. 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 22

Read-only values on the record.

# type: string; Returns the type of the current element.
# multiple: bool; Returns whether multiple value is set.
# currentlyRequired: bool; Returns element current required option used in validation
# 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 25

Take no arguments.

# getType(): string; Returns the type of the current element.
# isMultiple(): bool; Returns whether multiple value is set.
# isCurrentlyRequired(): bool; Returns element current required option used in validation
# 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. Imploded every array of each submitted file data by ', ' and such arrays between each other by '; '. It's not recommended to use this method if file input is multiple. 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

InputFile

Templates view

Properties 26

Methods 2

API & Jobs view

Properties 22

Admin view

Properties 25

Methods 2