TFile
extends TField
in package
implements
AdiantiWidgetInterface
FileChooser widget
Tags
Table of Contents
Interfaces
- AdiantiWidgetInterface
- Widget Interface
Properties
- $completeAction : mixed
- $displayMode : mixed
- $editable : mixed
- $errorAction : mixed
- $extensions : mixed
- $fileHandling : mixed
- $formName : mixed
- $galleryHeight : mixed
- $galleryWidth : mixed
- $height : mixed
- $id : mixed
- $imageGallery : mixed
- $label : mixed
- $limitSize : mixed
- $name : mixed
- $placeHolder : mixed
- $popcontent : mixed
- $popover : mixed
- $poptitle : mixed
- $properties : mixed
- $seed : mixed
- $size : mixed
- $tag : mixed
- $uploaderClass : mixed
- $value : mixed
- $valueCallback : mixed
- $validations : mixed
Methods
- __call() : mixed
- Redirects function call
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Constructor method
- __get() : mixed
- Returns a property value
- __isset() : mixed
- Returns if the property is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- addValidation() : mixed
- Add a field validator
- clearField() : mixed
- Clear the field
- disableField() : mixed
- Disable the field
- disableFileHandling() : mixed
- Disable file handling
- enableField() : mixed
- Enable the field
- enableFileHandling() : mixed
- Define to file handling
- enableImageGallery() : mixed
- Enable image gallery view
- enablePHPFileUploadLimit() : mixed
- Define upload size limit
- enablePopover() : mixed
- Enable popover
- getContents() : mixed
- Returns the element content as a string
- getEditable() : A
- Returns if the field is editable
- getFormName() : mixed
- Return the name of the form to wich the field is attached
- getId() : mixed
- Returns the field's id
- getLabel() : mixed
- Returns the field's label
- getName() : mixed
- Returns the field's name
- getPostData() : mixed
- Return the post data
- getPropertiesAsString() : mixed
- Get properties as string
- getProperty() : mixed
- Return a field property
- getSize() : mixed
- Returns the field size
- getValidations() : mixed
- Returns field validations
- getValue() : mixed
- Returns the field's value
- isRequired() : mixed
- Returns if the field is required
- setAllowedExtensions() : mixed
- Define the allowed extensions
- setCompleteAction() : mixed
- Define the action to be executed when upload is finished
- setDisplayMode() : mixed
- Define the display mode {file}
- setEditable() : mixed
- Define if the field is editable
- setErrorAction() : mixed
- Define the action to be executed when some error occurs
- setFormName() : mixed
- Define the name of the form to wich the field is attached
- setHeight() : mixed
- Set field height
- setId() : mixed
- Define the field's id
- setLabel() : mixed
- Define the field's label
- setLimitUploadSize() : mixed
- Define upload size limit
- setName() : mixed
- Define the field's name
- setPlaceHolder() : mixed
- Set place holder
- setProperty() : mixed
- Define a field property
- setService() : mixed
- Define the service class for response
- setSize() : mixed
- Set field size
- setTagName() : mixed
- Change input tag name
- setTip() : mixed
- Define the field's tooltip
- setValue() : mixed
- Set field value
- setValueCallback() : mixed
- Set callback for setValue method
- show() : mixed
- Show the widget at the screen
- validate() : mixed
- Validate a field
Properties
$completeAction
protected
mixed
$completeAction
$displayMode
protected
mixed
$displayMode
$editable
protected
mixed
$editable
$errorAction
protected
mixed
$errorAction
$extensions
protected
mixed
$extensions
$fileHandling
protected
mixed
$fileHandling
$formName
protected
mixed
$formName
$galleryHeight
protected
mixed
$galleryHeight
$galleryWidth
protected
mixed
$galleryWidth
$height
protected
mixed
$height
$id
protected
mixed
$id
$imageGallery
protected
mixed
$imageGallery
$label
protected
mixed
$label
$limitSize
protected
mixed
$limitSize
$name
protected
mixed
$name
$placeHolder
protected
mixed
$placeHolder
$popcontent
protected
mixed
$popcontent
$popover
protected
mixed
$popover
$poptitle
protected
mixed
$poptitle
$properties
protected
mixed
$properties
$seed
protected
mixed
$seed
$size
protected
mixed
$size
$tag
protected
mixed
$tag
$uploaderClass
protected
mixed
$uploaderClass
$value
protected
mixed
$value
$valueCallback
protected
mixed
$valueCallback
$validations
private
mixed
$validations
Methods
__call()
Redirects function call
public
__call( $method, $param) : mixed
Parameters
__clone()
Clone the object
public
__clone() : mixed
__construct()
Constructor method
public
__construct( $name) : mixed
Parameters
__get()
Returns a property value
public
__get( $name) : mixed
Parameters
__isset()
Returns if the property is set
public
__isset( $name) : mixed
Parameters
__set()
Intercepts whenever someones assign a new property's value
public
__set( $name, $value) : mixed
Parameters
__toString()
Converts the object into a string
public
__toString() : mixed
addValidation()
Add a field validator
public
addValidation( $label, $validator[, $parameters = NULL ]) : mixed
Parameters
clearField()
Clear the field
public
static clearField( $form_name, $field) : mixed
Parameters
disableField()
Disable the field
public
static disableField( $form_name, $field) : mixed
Parameters
disableFileHandling()
Disable file handling
public
disableFileHandling() : mixed
enableField()
Enable the field
public
static enableField( $form_name, $field) : mixed
Parameters
enableFileHandling()
Define to file handling
public
enableFileHandling() : mixed
enableImageGallery()
Enable image gallery view
public
enableImageGallery([mixed $width = null ][, mixed $height = 100 ]) : mixed
Parameters
- $width : mixed = null
- $height : mixed = 100
enablePHPFileUploadLimit()
Define upload size limit
public
enablePHPFileUploadLimit() : mixed
enablePopover()
Enable popover
public
enablePopover([ $title = null ][, $content = '' ]) : mixed
Parameters
getContents()
Returns the element content as a string
public
getContents() : mixed
getEditable()
Returns if the field is editable
public
getEditable() : A
Return values
A —boolean
getFormName()
Return the name of the form to wich the field is attached
public
getFormName() : mixed
getId()
Returns the field's id
public
getId() : mixed
getLabel()
Returns the field's label
public
getLabel() : mixed
getName()
Returns the field's name
public
getName() : mixed
getPostData()
Return the post data
public
getPostData() : mixed
getPropertiesAsString()
Get properties as string
public
getPropertiesAsString([mixed $filter = null ]) : mixed
Parameters
- $filter : mixed = null
getProperty()
Return a field property
public
getProperty( $name) : mixed
Parameters
getSize()
Returns the field size
public
getSize() : mixed
getValidations()
Returns field validations
public
getValidations() : mixed
getValue()
Returns the field's value
public
getValue() : mixed
isRequired()
Returns if the field is required
public
isRequired() : mixed
setAllowedExtensions()
Define the allowed extensions
public
setAllowedExtensions(mixed $extensions) : mixed
Parameters
- $extensions : mixed
setCompleteAction()
Define the action to be executed when upload is finished
public
setCompleteAction( $action) : mixed
Parameters
setDisplayMode()
Define the display mode {file}
public
setDisplayMode(mixed $mode) : mixed
Parameters
- $mode : mixed
setEditable()
Define if the field is editable
public
setEditable( $editable) : mixed
Parameters
setErrorAction()
Define the action to be executed when some error occurs
public
setErrorAction( $action) : mixed
Parameters
setFormName()
Define the name of the form to wich the field is attached
public
setFormName( $name) : mixed
Parameters
Tags
setHeight()
Set field height
public
setHeight(mixed $height) : mixed
Parameters
- $height : mixed
setId()
Define the field's id
public
setId( $id) : mixed
Parameters
setLabel()
Define the field's label
public
setLabel( $label) : mixed
Parameters
setLimitUploadSize()
Define upload size limit
public
setLimitUploadSize( $limit) : mixed
Parameters
setName()
Define the field's name
public
setName( $name) : mixed
Parameters
setPlaceHolder()
Set place holder
public
setPlaceHolder(TElement $widget) : mixed
Parameters
- $widget : TElement
setProperty()
Define a field property
public
setProperty( $name, $value[, mixed $replace = TRUE ]) : mixed
Parameters
setService()
Define the service class for response
public
setService(mixed $service) : mixed
Parameters
- $service : mixed
setSize()
Set field size
public
setSize(mixed $width[, mixed $height = NULL ]) : mixed
Parameters
- $width : mixed
-
Field's width in pixels
- $height : mixed = NULL
setTagName()
Change input tag name
public
setTagName(mixed $name) : mixed
Parameters
- $name : mixed
setTip()
Define the field's tooltip
public
setTip(mixed $tip) : mixed
Parameters
- $tip : mixed
setValue()
Set field value
public
setValue(mixed $value) : mixed
Parameters
- $value : mixed
-
A string containing the field's value
setValueCallback()
Set callback for setValue method
public
setValueCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
show()
Show the widget at the screen
public
show() : mixed
validate()
Validate a field
public
validate() : mixed