Class Quform_Element_File

Quform_Element_File implements Quform_Attachable, Quform_Element_Editable

Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Element/File.php

Methods summary
`public boolean`	# `isValid( )` Is the uploaded file valid? Is the uploaded file valid? Returns boolean True if valid, false otherwise Overrides `Quform_Element_Field::isValid()`
`protected boolean`	# `hasUploadedFile( )` Returns true if at least one actual file was uploaded for this element, i.e. $_FILES contains an entry for it with an UPLOAD_ERR_OK error code. An empty file input (UPLOAD_ERR_NO_FILE) or a missing key returns false. Returns true if at least one actual file was uploaded for this element, i.e. $_FILES contains an entry for it with an UPLOAD_ERR_OK error code. An empty file input (UPLOAD_ERR_NO_FILE) or a missing key returns false. Returns boolean
`public Quform_Validator_FileUpload`	# `getFileUploadValidator( )` Returns `Quform_Validator_FileUpload`
`public boolean`	# `isRequired( )` Gets whether the element is required Gets whether the element is required Returns boolean Overrides `Quform_Element_Field::isRequired()`
`public array`	# `getEmptyValue( )` Returns array Overrides `Quform_Element_Field::getEmptyValue()`
`public array`	# `getValue( )` Get the value of this element Get the value of this element Returns array Overrides `Quform_Element_Field::getValue()`
`public string`	# `getValueHtml( )` Get the value formatted in HTML Get the value formatted in HTML Returns string Overrides `Quform_Element_Field::getValueHtml()`
`public string`	# `getValueText( string $separator = ', ' )` Get the value formatted in plain text Get the value formatted in plain text Parameters `$separator` The separator between values Returns string Overrides `Quform_Element_Field::getValueText()`
`public`	# `addFile( array $file )` Add a file upload to the value Add a file upload to the value Parameters `$file`
`protected boolean`	# `isValidValue( array $value )` Parameters `$value` Returns boolean Overrides `Quform_Element_Field::isValidValue()`
`protected boolean`	# `isValidFile( array $file )` Returns true if the given file is a valid file array, false otherwise Returns true if the given file is a valid file array, false otherwise Parameters `$file` Returns boolean
`protected string`	# `getConvertedValueForStorage( )` Get the value in storage format Get the value in storage format Returns string Overrides `Quform_Element_Field::getConvertedValueForStorage()`
`protected array`	# `convertValueFromStorage( string $value )` Convert given the value from storage format Convert given the value from storage format Parameters `$value` Returns array Overrides `Quform_Element_Field::convertValueFromStorage()`
`protected array`	# `getFieldAttributes( array $context = array() )` Get the HTML attributes for the field Get the HTML attributes for the field Parameters `$context` Returns array
`protected array`	# `getFieldClasses( array $context = array() )` Get the classes for the field Get the classes for the field Parameters `$context` Returns array
`protected array`	# `getUploaderConfig( )` Get the enhanced upload config options Get the enhanced upload config options Returns array
`protected string`	# `getFieldHtml( array $context = array() )` Get the HTML for the field Get the HTML for the field Parameters `$context` Returns string
`protected array`	# `getInnerClasses( array $context = array() )` Get the classes for the element inner wrapper Get the classes for the element inner wrapper Parameters `$context` Returns array Overrides `Quform_Element_Field::getInnerClasses()`
`protected array`	# `getInputClasses( array $context = array() )` Get the classes for the element input wrapper Get the classes for the element input wrapper Parameters `$context` Returns array Overrides `Quform_Element_Field::getInputClasses()`
`protected string`	# `getInputHtml( array $context = array() )` Get the HTML for the element input wrapper Get the HTML for the element input wrapper Parameters `$context` Returns string Overrides `Quform_Element_Field::getInputHtml()`
`public string`	# `getEditFieldHtml( )` Get the field HTML when editing Get the field HTML when editing Returns string Implementation of `Quform_Element_Editable::getEditFieldHtml()`
`public boolean`	# `hasAttachments( )` Returns boolean Implementation of `Quform_Attachable::hasAttachments()`
`public array`	# `getAttachments( )` Returns array Implementation of `Quform_Attachable::getAttachments()`
`protected string`	# `renderCss( array $context = array() )` Render the CSS for this element Render the CSS for this element Parameters `$context` Returns string Overrides `Quform_Element_Field::renderCss()`
`protected array`	# `getCssSelectors( )` Get the list of CSS selectors Get the list of CSS selectors Returns array Overrides `Quform_Element_Field::getCssSelectors()`
`protected array`	# `prepareContext( array $context = array() )` Inherit settings from this element into the context Inherit settings from this element into the context Parameters `$context` Returns array Overrides `Quform_Element::prepareContext()`
`public static array`	# `getDefaultConfig( string\|null $key = null )` Get the default element configuration Get the default element configuration Parameters `$key` Get the config by key, if omitted the full config is returned Returns array

Methods inherited from Quform_Element_Field
addError(), addFilter(), addValidator(), clearError(), clearErrors(), clearFilters(), clearValidators(), filterValue(), filterValueRecursive(), getAdminLabel(), getBelongsTo(), getDefaultValue(), getDescriptionHtml(), getEditLabelHtml(), getElementClasses(), getError(), getErrorArray(), getErrorHtml(), getErrors(), getFieldIconsHtml(), getFilter(), getFilters(), getFullyQualifiedName(), getIdentifier(), getLabel(), getLabelHtml(), getName(), getSubLabelHtml(), getTooltip(), getUniqueId(), getValidator(), getValidators(), getValueForStorage(), getValueRaw(), hasDefaultValue(), hasError(), hasFilter(), hasFilters(), hasValidator(), hasValidators(), hasValue(), isEmpty(), isLogicRuleMatch(), isLogicValueMatch(), isMultiple(), prepareDynamicValue(), removeFilter(), removeValidator(), render(), reset(), setBelongsTo(), setDefaultValue(), setDynamicDefaultValue(), setError(), setIsMultiple(), setValue(), setValueFromStorage(), shouldConvertToHidden()

Methods inherited from Quform_Element
`__construct(), config(), getCss(), getCssSelector(), getForm(), getId(), getTranslation(), hasNonVisibleAncestor(), isConditionallyHidden(), isHidden(), isVisible(), setConditionallyHidden(), setConfig(), setForm(), setHasNonVisibleAncestor(), setId(), setUniqueId()`

Properties summary
`protected array`	`$value` The value which is an array of any uploaded files The value which is an array of any uploaded files	# `array()`
`protected boolean`	`$isMultiple`	# `true`

Properties inherited from Quform_Element_Field
`$belongsTo, $defaultValue, $errors, $filters, $validators`

Properties inherited from Quform_Element
`$config, $form, $hasNonVisibleAncestor, $id, $isConditionallyHidden, $uniqueId`

Namespaces

Classes

Interfaces

Class Quform_Element_File

Returns

Overrides

Returns

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Parameters

Returns

Overrides

Parameters

Returns

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns