Overview

Classes

  • Quform
  • Quform_Admin_InsertForm
  • Quform_Admin_Page
  • Quform_Admin_Page_Controller
  • Quform_Admin_Page_Dashboard
  • Quform_Admin_Page_Entries
  • Quform_Admin_Page_Entries_Edit
  • Quform_Admin_Page_Entries_List
  • Quform_Admin_Page_Entries_View
  • Quform_Admin_Page_Factory
  • Quform_Admin_Page_Forms_Add
  • Quform_Admin_Page_Forms_Edit
  • Quform_Admin_Page_Forms_List
  • Quform_Admin_Page_Help
  • Quform_Admin_Page_Preview
  • Quform_Admin_Page_Settings
  • Quform_Admin_Page_Tools
  • Quform_Admin_Page_Tools_ExportEntries
  • Quform_Admin_Page_Tools_ExportForm
  • Quform_Admin_Page_Tools_Home
  • Quform_Admin_Page_Tools_ImportForm
  • Quform_Admin_Page_Tools_Migrate
  • Quform_Admin_Page_Tools_Uninstall
  • Quform_Api
  • Quform_Block
  • Quform_Builder
  • Quform_Captcha
  • Quform_ClassLoader
  • Quform_Confirmation
  • Quform_Container
  • Quform_Dashboard_Widget
  • Quform_Dispatcher
  • Quform_Element
  • Quform_Element_Captcha
  • Quform_Element_Checkbox
  • Quform_Element_Column
  • Quform_Element_Container
  • Quform_Element_Container_Iterator
  • Quform_Element_Date
  • Quform_Element_Email
  • Quform_Element_Factory
  • Quform_Element_Field
  • Quform_Element_File
  • Quform_Element_Group
  • Quform_Element_Hidden
  • Quform_Element_Honeypot
  • Quform_Element_Html
  • Quform_Element_Multi
  • Quform_Element_Multiselect
  • Quform_Element_Name
  • Quform_Element_Page
  • Quform_Element_Password
  • Quform_Element_Radio
  • Quform_Element_Recaptcha
  • Quform_Element_Row
  • Quform_Element_Select
  • Quform_Element_Submit
  • Quform_Element_Text
  • Quform_Element_Textarea
  • Quform_Element_Time
  • Quform_Entry_Controller
  • Quform_Entry_Exporter
  • Quform_Entry_List_Settings
  • Quform_Entry_List_Table
  • Quform_Entry_Processor
  • Quform_Entry_UserSearcher
  • Quform_Filter_Abstract
  • Quform_Filter_Alpha
  • Quform_Filter_AlphaNumeric
  • Quform_Filter_Digits
  • Quform_Filter_Regex
  • Quform_Filter_Static
  • Quform_Filter_StripTags
  • Quform_Filter_Trim
  • Quform_Form
  • Quform_Form_Controller
  • Quform_Form_Exporter
  • Quform_Form_Factory
  • Quform_Form_Importer
  • Quform_Form_Iterator
  • Quform_Form_List_Settings
  • Quform_Form_List_Table
  • Quform_Form_Processor
  • Quform_License
  • Quform_Migrator
  • Quform_NonceRefresher
  • Quform_Notification
  • Quform_Notification_Resender
  • Quform_Options
  • Quform_Permissions
  • Quform_Repository
  • Quform_ScriptLoader
  • Quform_Session
  • Quform_Settings
  • Quform_Shortcode
  • Quform_Themes
  • Quform_TokenReplacer
  • Quform_Toolbar
  • Quform_Translations
  • Quform_Updater
  • Quform_Upgrader
  • Quform_Uploader
  • Quform_Validator_Abstract
  • Quform_Validator_Alpha
  • Quform_Validator_AlphaNumeric
  • Quform_Validator_Array
  • Quform_Validator_Captcha
  • Quform_Validator_Date
  • Quform_Validator_Digits
  • Quform_Validator_Duplicate
  • Quform_Validator_Email
  • Quform_Validator_FileUpload
  • Quform_Validator_GreaterThan
  • Quform_Validator_Honeypot
  • Quform_Validator_Identical
  • Quform_Validator_InArray
  • Quform_Validator_Length
  • Quform_Validator_LessThan
  • Quform_Validator_Recaptcha
  • Quform_Validator_Regex
  • Quform_Validator_Required
  • Quform_Validator_Static
  • Quform_Validator_Time
  • Quform_View
  • Quform_ViewFactory
  • Quform_Widget_Form
  • Quform_Widget_Popup

Interfaces

  • Quform_Attachable
  • Quform_Element_Editable
  • Quform_Filter_Interface
  • Quform_Validator_Interface
  • Overview
  • Class

Class Quform_Element_File

Quform_Element
Extended by Quform_Element_Field
Extended by 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()
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
API documentation generated by ApiGen