Public Member Functions
	loadDefaultDecorators ()
	Load default decorators.

	setPluginLoader (Zend_Loader_PluginLoader_Interface $loader, $type)
	Set plugin loader.

	getPluginLoader ($type)
	Get Plugin Loader.

	addPrefixPath ($prefix, $path, $type=null)
	Add prefix path for plugin loader.

	setTransferAdapter ($adapter)
	Set transfer adapter.

	getTransferAdapter ()
	Get transfer adapter.

	addValidator ($validator, $breakChainOnFailure=false, $options=array())
	Add Validator; proxy to adapter.

	addValidators (array $validators)
	Add multiple validators at once; proxy to adapter.

	setValidators (array $validators)
	Add multiple validators at once, overwriting; proxy to adapter.

	getValidator ($name)
	Retrieve validator by name; proxy to adapter.

	getValidators ()
	Retrieve all validators; proxy to adapter.

	removeValidator ($name)
	Remove validator by name; proxy to adapter.

	clearValidators ()
	Remove all validators; proxy to adapter.

	addFilter ($filter, $options=null)
	Add Filter; proxy to adapter.

	addFilters (array $filters)
	Add Multiple filters at once; proxy to adapter.

	setFilters (array $filters)
	Sets a filter for the class, erasing all previous set; proxy to adapter.

	getFilter ($name)
	Retrieve individual filter; proxy to adapter.

	getFilters ()
	Returns all set filters; proxy to adapter.

	removeFilter ($name)
	Remove an individual filter; proxy to adapter.

	clearFilters ()
	Remove all filters; proxy to adapter.

	isValid ($value, $context=null)
	Validate upload.

	receive ()
	Receive the uploaded file.

	getErrors ()
	Retrieve error codes; proxy to transfer adapter.

	hasErrors ()
	Are there errors registered?

	getMessages ()
	Retrieve error messages; proxy to transfer adapter.

	setDestination ($path)
	Set the upload destination.

	getDestination ()
	Get the upload destination.

	getFileName ($value=null, $path=true)
	Get the final filename.

	getFileInfo ($value=null)
	Get internal file informations.

	setMultiFile ($count)
	Set a multifile element.

	getMultiFile ()
	Returns the multifile element number.

	getMaxFileSize ()
	Sets the maximum file size of the form.

	setMaxFileSize ($size)
	Sets the maximum file size of the form.

	setValueDisabled ($flag)
	Set if the file will be uploaded when getting the value This defaults to false which will force receive() when calling getValues()

	isValueDisabled ()
	Returns if the file will be uploaded when calling getValues()

	getValue ()
	Processes the file, returns null or the filename only For the complete path, use getFileName.

	setValue ($value)
	Disallow setting the value.

	setTranslator ($translator=null)
	Set translator object for localization.

	getTranslator ()
	Retrieve localization translator object.

	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.

	translatorIsDisabled ()
	Is translation disabled?

	isReceived ()
	Was the file received?

	isUploaded ()
	Was the file uploaded?

	isFiltered ()
	Has the file been filtered?

	getHash ($hash= 'crc32')
	Returns the hash for this file element.

	getFileSize ()
	Returns the filesize for this file element.

	getMimeType ()
	Returns the mimetype for this file element.

	render (Zend_View_Interface $view=null)
	Render form element Checks for decorator interface to prevent errors.

Public Attributes
const	TRANSFER_ADAPTER = 'TRANSFER_ADAPTER'
	Plugin loader type.

	$helper = 'formFile'

Protected Member Functions
	_getErrorMessages ()
	Retrieve error messages and perform translation and value substitution.

Protected Attributes
	$_adapter

	$_validated = false

	$_valueDisabled = false

	$_counter = 1

Static Protected Attributes
static	$_maxFileSize = -1

Additional Inherited Members
Static Public Member Functions inherited from Zend_Form_Element
static	resolveElementId (Zend_Form_Decorator_Interface $decorator)
	Used to resolve and return an element ID.

Member Function Documentation

_getErrorMessages ( )

protected

Retrieve error messages and perform translation and value substitution.

Returns: array

addFilter	(	$filter,
		$options = `null`
	)

Add Filter; proxy to adapter.

Parameters

string \| array	$filter	Type of filter to add
string \| array	$options	Options to set for the filter

Returns: Zend_Form_Element_File

addFilters ( array $filters )

Add Multiple filters at once; proxy to adapter.

Parameters

array $filters

Returns: Zend_Form_Element_File

addPrefixPath	(	$prefix,
		$path,
		$type = `null`
	)

Add prefix path for plugin loader.

Parameters

string	$prefix
string	$path
string	$type

Returns: Zend_Form_Element_File

addValidator	(	$validator,
		$breakChainOnFailure = `false`,
		$options = `array()`
	)

Add Validator; proxy to adapter.

Parameters

string \| Zend_Validate_Interface	$validator
bool	$breakChainOnFailure
mixed	$options

Returns: Zend_Form_Element_File

addValidators ( array $validators )

Add multiple validators at once; proxy to adapter.

Parameters

array $validators

Returns: Zend_Form_Element_File

clearFilters ( )

Remove all filters; proxy to adapter.

Returns: Zend_Form_Element_File

clearValidators ( )

Remove all validators; proxy to adapter.

Returns: Zend_Form_Element_File

getDestination ( )

Get the upload destination.

Returns: string

getErrors ( )

Retrieve error codes; proxy to transfer adapter.

Returns: array

getFileInfo ( $value = null )

Get internal file informations.

Parameters

string $value (Optional) Element or file to return

Returns: array

getFileName	(	$value = `null`,
		$path = `true`
	)

Get the final filename.

Parameters

string	$value	(Optional) Element or file to return
boolean	$path	(Optional) Return also the path, defaults to true

Returns: string

getFileSize ( )

Returns the filesize for this file element.

Returns: string|array Filesize

getFilter ( $name )

Retrieve individual filter; proxy to adapter.

Parameters

string $name

Returns: Zend_Filter_Interface|null

getFilters ( )

Returns all set filters; proxy to adapter.

Returns: array List of set filters

getHash ( $hash = 'crc32' )

Returns the hash for this file element.

Parameters

string $hash (Optional) Hash algorithm to use

Returns: string|array Hashstring

getMaxFileSize ( )

Sets the maximum file size of the form.

Returns: integer

getMessages ( )

Retrieve error messages; proxy to transfer adapter.

Returns: array

Implements Zend_Validate_Interface.

getMimeType ( )

Returns the mimetype for this file element.

Returns: string|array Mimetype

getMultiFile ( )

Returns the multifile element number.

Returns: integer

getPluginLoader ( $type )

Get Plugin Loader.

Parameters

string $type

Returns: Zend_Loader_PluginLoader_Interface

getTransferAdapter ( )

Get transfer adapter.

Lazy loads HTTP transfer adapter when no adapter registered.

Returns: Zend_File_Transfer_Adapter_Abstract

getTranslator ( )

Retrieve localization translator object.

Returns: Zend_Translate_Adapter|null

getValidator ( $name )

Retrieve validator by name; proxy to adapter.

Parameters

string $name

Returns: Zend_Validate_Interface|null

getValidators ( )

Retrieve all validators; proxy to adapter.

Returns: array

getValue ( )

Processes the file, returns null or the filename only For the complete path, use getFileName.

Returns: null|string

hasErrors ( )

Are there errors registered?

Returns: bool

isFiltered ( )

Has the file been filtered?

Returns: bool

isReceived ( )

Was the file received?

Returns: bool

isUploaded ( )

Was the file uploaded?

Returns: bool

isValid	(	$value,
		$context = `null`
	)

Validate upload.

Parameters

string	$value	File, can be optional, give null to validate all files
mixed	$context

Returns: bool

isValueDisabled ( )

Returns if the file will be uploaded when calling getValues()

Returns: boolean Receive the file on calling getValues()?

loadDefaultDecorators ( )

Load default decorators.

Returns: Zend_Form_Element_File

receive ( )

Receive the uploaded file.

Returns: boolean

removeFilter ( $name )

Remove an individual filter; proxy to adapter.

Parameters

string $name

Returns: Zend_Form_Element_File

removeValidator ( $name )

Remove validator by name; proxy to adapter.

Parameters

string $name

Returns: Zend_Form_Element_File

render ( Zend_View_Interface $view = null )

Render form element Checks for decorator interface to prevent errors.

Parameters

Zend_View_Interface $view

Returns: string

Exceptions

Zend_Form_Element_Exception

setDestination ( $path )

Set the upload destination.

Parameters

string $path

Returns: Zend_Form_Element_File

setDisableTranslator ( $flag )

Indicate whether or not translation should be disabled.

Parameters

bool $flag

Returns: Zend_Form_Element_File

setFilters ( array $filters )

Sets a filter for the class, erasing all previous set; proxy to adapter.

Parameters

array $filters Filters to set

Returns: Zend_Form_Element_File

setMaxFileSize ( $size )

Sets the maximum file size of the form.

Parameters

integer $size

Returns: integer

setMultiFile ( $count )

Set a multifile element.

Parameters

integer $count Number of file elements

Returns: Zend_Form_Element_File Provides fluent interface

setPluginLoader	(	Zend_Loader_PluginLoader_Interface	$loader,
			$type
	)

Set plugin loader.

Parameters

Zend_Loader_PluginLoader_Interface	$loader
string	$type

Returns: Zend_Form_Element_File

setTransferAdapter ( $adapter )

Set transfer adapter.

Parameters

string | Zend_File_Transfer_Adapter_Abstract $adapter

Returns: Zend_Form_Element_File

Exceptions

Zend_Form_Element_Exception

setTranslator ( $translator = null )

Set translator object for localization.

Parameters

Zend_Translate | null $translator

Returns: Zend_Form_Element_File

setValidators ( array $validators )

Add multiple validators at once, overwriting; proxy to adapter.

Parameters

array $validators

Returns: Zend_Form_Element_File

setValue ( $value )

Disallow setting the value.

Parameters

mixed $value

Returns: Zend_Form_Element_File

setValueDisabled ( $flag )

Set if the file will be uploaded when getting the value This defaults to false which will force receive() when calling getValues()

Parameters

boolean $flag Sets if the file is handled as the elements value

Returns: Zend_Form_Element_File

translatorIsDisabled ( )

Is translation disabled?

Returns: bool

Member Data Documentation

$_adapter

protected

$_counter = 1

protected

$_maxFileSize = -1

staticprotected

$_validated = false

protected

$_valueDisabled = false

protected

$helper = 'formFile'

const TRANSFER_ADAPTER = 'TRANSFER_ADAPTER'

Plugin loader type.

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation