API Documentation

Form/Element/File.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
Classes
Zend_Form_Element_File

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Form_Element_File
jump to top

Extends from
Zend_Form_Element_Xhtml
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Form
subpackage
Element
version
$Id: File.php 22372 2010-06-04 20:17:58Z thomas $
Constants
TRANSFER_ADAPTER
Properties
$helper
$_adapter
$_validated
$_valueDisabled
$_counter
$_maxFileSize
Methods
loadDefaultDecorators
setPluginLoader
getPluginLoader
addPrefixPath
setTransferAdapter
getTransferAdapter
addValidator
addValidators
setValidators
getValidator
getValidators
removeValidator
clearValidators
addFilter
addFilters
setFilters
getFilter
getFilters
removeFilter
clearFilters
isValid
receive
getErrors
hasErrors
getMessages
setDestination
getDestination
getFileName
getFileInfo
setMultiFile
getMultiFile
getMaxFileSize
setMaxFileSize
_convertIniToInteger
setValueDisabled
isValueDisabled
getValue
setValue
setTranslator
getTranslator
setDisableTranslator
translatorIsDisabled
isReceived
isUploaded
isFiltered
getHash
getFileSize
getMimeType
render
_getErrorMessages

Description

Zend_Form_Element

Constants

TRANSFER_ADAPTER
jump to class

 TRANSFER_ADAPTER = 'TRANSFER_ADAPTER'

Plugin loader type

Details

value
TRANSFER_ADAPTER

Properties

$_adapter
jump to class

Zend_File_Transfer_Adapter_Abstract $_adapter = ''

Details

$_adapter
Zend_File_Transfer_Adapter_Abstract
visibility
protected
default
final
false
static
false

$_counter
jump to class

integer $_counter = '1'

Details

$_counter
integer
Internal multifile counter
visibility
protected
default
1
final
false
static
false

$_maxFileSize
jump to class

integer $_maxFileSize = '1'

Details

$_maxFileSize
integer
Maximum file size for MAX_FILE_SIZE attribut of form
visibility
protected
default
1
final
false
static
true

$_validated
jump to class

boolean $_validated = 'false'

Details

$_validated
boolean
Already validated ?
visibility
protected
default
false
final
false
static
false

$_valueDisabled
jump to class

boolean $_valueDisabled = 'false'

Details

$_valueDisabled
boolean
Disable value to be equal to file content
visibility
protected
default
false
final
false
static
false

$helper
jump to class

string $helper = 'formFile'

Details

$helper
string
Default view helper
visibility
public
default
formFile
final
false
static
false

Methods

_convertIniToInteger
jump to class

_convertIniToInteger( string $setting ) : integer

Converts a ini setting to a integer value

Arguments
$setting
string
Output
integer
Details
visibility
private
final
false
static
false

_getErrorMessages
jump to class

_getErrorMessages( ) : array

Retrieve error messages and perform translation and value substitution

Output
array
Details
visibility
protected
final
false
static
false

addFilter
jump to class

addFilter( string|array $filter, string|array $options = null ) : Zend_Form_Element_File

Add Filter; proxy to adapter

Arguments
$filter
stringarray
Type of filter to add
$options
stringarray
Options to set for the filter
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

addFilters
jump to class

addFilters( array $filters ) : Zend_Form_Element_File

Add Multiple filters at once; proxy to adapter

Arguments
$filters
array
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

addPrefixPath
jump to class

addPrefixPath( string $prefix, string $path, string $type = null ) : Zend_Form_Element_File

Add prefix path for plugin loader

Arguments
$prefix
string
$path
string
$type
string
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

addValidator
jump to class

addValidator( string|Zend_Validate_Interface $validator, bool $breakChainOnFailure = false, mixed $options = array ) : Zend_Form_Element_File

Add Validator; proxy to adapter

Arguments
$validator
stringZend_Validate_Interface
$breakChainOnFailure
bool
$options
mixed
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

addValidators
jump to class

addValidators( array $validators ) : Zend_Form_Element_File

Add multiple validators at once; proxy to adapter

Arguments
$validators
array
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

clearFilters
jump to class

clearFilters( ) : Zend_Form_Element_File

Remove all filters; proxy to adapter

Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

clearValidators
jump to class

clearValidators( ) : Zend_Form_Element_File

Remove all validators; proxy to adapter

Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

getDestination
jump to class

getDestination( ) : string

Get the upload destination

Output
string
Details
visibility
public
final
false
static
false

getErrors
jump to class

getErrors( ) : array

Retrieve error codes; proxy to transfer adapter

Output
array
Details
visibility
public
final
false
static
false

getFileInfo
jump to class

getFileInfo( string $value = null ) : array

Get internal file informations

Arguments
$value
string
(Optional) Element or file to return
Output
array
Details
visibility
public
final
false
static
false

getFileName
jump to class

getFileName( string $value = null, boolean $path = true ) : string

Get the final filename

Arguments
$value
string
(Optional) Element or file to return
$path
boolean
(Optional) Return also the path, defaults to true
Output
string
Details
visibility
public
final
false
static
false

getFileSize
jump to class

getFileSize( ) : string|array

Returns the filesize for this file element

Output
string|array
Filesize
Details
visibility
public
final
false
static
false

getFilter
jump to class

getFilter( string $name ) : Zend_Filter_Interface|null

Retrieve individual filter; proxy to adapter

Arguments
$name
string
Output
Zend_Filter_Interface|null
Details
visibility
public
final
false
static
false

getFilters
jump to class

getFilters( ) : array

Returns all set filters; proxy to adapter

Output
array
List of set filters
Details
visibility
public
final
false
static
false

getHash
jump to class

getHash( string $hash = crc32 ) : string|array

Returns the hash for this file element

Arguments
$hash
string
(Optional) Hash algorithm to use
Output
string|array
Hashstring
Details
visibility
public
final
false
static
false

getMaxFileSize
jump to class

getMaxFileSize( ) : integer

Sets the maximum file size of the form

Output
integer
Details
visibility
public
final
false
static
false

getMessages
jump to class

getMessages( ) : array

Retrieve error messages; proxy to transfer adapter

Output
array
Details
visibility
public
final
false
static
false

getMimeType
jump to class

getMimeType( ) : string|array

Returns the mimetype for this file element

Output
string|array
Mimetype
Details
visibility
public
final
false
static
false

getMultiFile
jump to class

getMultiFile( ) : integer

Returns the multifile element number

Output
integer
Details
visibility
public
final
false
static
false

getPluginLoader
jump to class

getPluginLoader( string $type ) : Zend_Loader_PluginLoader_Interface

Get Plugin Loader

Arguments
$type
string
Output
Zend_Loader_PluginLoader_Interface
Details
visibility
public
final
false
static
false

getTransferAdapter
jump to class

getTransferAdapter( ) : Zend_File_Transfer_Adapter_Abstract

Get transfer adapter

Lazy loads HTTP transfer adapter when no adapter registered.

Output
Zend_File_Transfer_Adapter_Abstract
Details
visibility
public
final
false
static
false

getTranslator
jump to class

getTranslator( ) : Zend_Translate_Adapter|null

Retrieve localization translator object

Output
Zend_Translate_Adapter|null
Details
visibility
public
final
false
static
false

getValidator
jump to class

getValidator( string $name ) : Zend_Validate_Interface|null

Retrieve validator by name; proxy to adapter

Arguments
$name
string
Output
Zend_Validate_Interface|null
Details
visibility
public
final
false
static
false

getValidators
jump to class

getValidators( ) : array

Retrieve all validators; proxy to adapter

Output
array
Details
visibility
public
final
false
static
false

getValue
jump to class

getValue( ) : null|string

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

Output
null|string
Details
visibility
public
final
false
static
false

hasErrors
jump to class

hasErrors( ) : bool

Are there errors registered?

Output
bool
Details
visibility
public
final
false
static
false

isFiltered
jump to class

isFiltered( ) : bool

Has the file been filtered?

Output
bool
Details
visibility
public
final
false
static
false

isReceived
jump to class

isReceived( ) : bool

Was the file received?

Output
bool
Details
visibility
public
final
false
static
false

isUploaded
jump to class

isUploaded( ) : bool

Was the file uploaded?

Output
bool
Details
visibility
public
final
false
static
false

isValid
jump to class

isValid( string $value, mixed $context = null ) : bool

Validate upload

Arguments
$value
string
File, can be optional, give null to validate all files
$context
mixed
Output
bool
Details
visibility
public
final
false
static
false

isValueDisabled
jump to class

isValueDisabled( ) : boolean

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

Output
boolean
Receive the file on calling getValues()?
Details
visibility
public
final
false
static
false

loadDefaultDecorators
jump to class

loadDefaultDecorators( ) : void

Load default decorators

Details
visibility
public
final
false
static
false

receive
jump to class

receive( ) : boolean

Receive the uploaded file

Output
boolean
Details
visibility
public
final
false
static
false

removeFilter
jump to class

removeFilter( string $name ) : Zend_Form_Element_File

Remove an individual filter; proxy to adapter

Arguments
$name
string
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

removeValidator
jump to class

removeValidator( string $name ) : Zend_Form_Element_File

Remove validator by name; proxy to adapter

Arguments
$name
string
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

render
jump to class

render( Zend_View_Interface $view = null ) : string

Render form element Checks for decorator interface to prevent errors

Arguments
$view
Zend_View_Interface
Output
string
Details
visibility
public
final
false
static
false

setDestination
jump to class

setDestination( string $path ) : Zend_Form_Element_File

Set the upload destination

Arguments
$path
string
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setDisableTranslator
jump to class

setDisableTranslator( bool $flag ) : Zend_Form_Element_File

Indicate whether or not translation should be disabled

Arguments
$flag
bool
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setFilters
jump to class

setFilters(  $filters ) : Zend_Form_Element_File

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

Arguments
$filters
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setMaxFileSize
jump to class

setMaxFileSize( integer $size ) : integer

Sets the maximum file size of the form

Arguments
$size
integer
Output
integer
Details
visibility
public
final
false
static
false

setMultiFile
jump to class

setMultiFile( integer $count ) : Zend_Form_Element_File

Set a multifile element

Arguments
$count
integer
Number of file elements
Output
Zend_Form_Element_File
Provides fluent interface
Details
visibility
public
final
false
static
false

setPluginLoader
jump to class

setPluginLoader( Zend_Loader_PluginLoader_Interface $loader, string $type ) : Zend_Form_Element_File

Set plugin loader

Arguments
$loader
Zend_Loader_PluginLoader_Interface
$type
string
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setTransferAdapter
jump to class

setTransferAdapter( string|Zend_File_Transfer_Adapter_Abstract $adapter ) : Zend_Form_Element_File

Set transfer adapter

Arguments
$adapter
stringZend_File_Transfer_Adapter_Abstract
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setTranslator
jump to class

setTranslator( Zend_Translate|null $translator = null ) : Zend_Form_Element_File

Set translator object for localization

Arguments
$translator
Zend_Translatenull
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setValidators
jump to class

setValidators( array $validators ) : Zend_Form_Element_File

Add multiple validators at once, overwriting; proxy to adapter

Arguments
$validators
array
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setValue
jump to class

setValue( mixed $value ) : Zend_Form_Element_File

Disallow setting the value

Arguments
$value
mixed
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

setValueDisabled
jump to class

setValueDisabled( boolean $flag ) : Zend_Form_Element_File

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

Arguments
$flag
boolean
Sets if the file is handled as the elements value
Output
Zend_Form_Element_File
Details
visibility
public
final
false
static
false

translatorIsDisabled
jump to class

translatorIsDisabled( ) : bool

Is translation disabled?

Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.