Abstract class Zend_File_Transfer_Adapter_Abstract

abstract class Zend_File_Transfer_Adapter_Abstract

Defined in line 30 of file File/Transfer/Adapter/Abstract.php.

Subclasses : Zend_File_Transfer_Adapter_Http

Abstract class for file transfers (Downloads and Uploads)

Category	Zend
Package	Zend_File_Transfer
Copyright	Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
License	http://framework.zend.com/license/new-bsd New BSD License

Overview

Class constants

FILTER VALIDATE

Instance fields$_break $_files $_filters $_loaders $_messages $_options $_tmpDir $_translator $_translatorDisabled $_validators

Static methods_toByteString() getProgress()

Summary

Class constants

FILTER
VALIDATE

Instance fields

# $_break	Internal list of breaks
# $_files	Internal list of files
# $_filters	Internal list of filters
# $_loaders	Plugin loaders for filter and validation chains
# $_messages	Internal list of messages
# $_options	Available options for file transfers
# $_tmpDir	TMP directory
# $_translator
# $_translatorDisabled	Is translation disabled?
# $_validators	Internal list of validators

Static methods

# _toByteString()	Returns the formatted size
+ getProgress()	Retrieve progress of transfer

Instance methods

# _filter()	Internal function to filter all given files
# _getFiles()	Returns found files based on internal file array and given files
# _getFilterIdentifier()	Retrieve internal identifier for a named filter
# _getTmpDir()	Determine system TMP directory and detect if we have read access
# _getValidatorIdentifier()	Retrieve internal identifier for a named validator
# _isPathWriteable()	Tries to detect if we can read and write to the given path
+ addFile()	Adds one or more files
+ addFilter()	Adds a new filter for this class
+ addFilters()	Add Multiple filters at once
+ addPrefixPath()	Add prefix path for plugin loader
+ addPrefixPaths()	Add many prefix paths at once
+ addType()	Adds one or more type of files
+ addValidator()	Adds a new validator for this class
+ addValidators()	Add Multiple validators at once
+ clearFilters()	Remove all filters
+ clearValidators()	Remove all validators
+ getDestination()	Retrieve destination directory value
+ getErrors()	Retrieve error codes
+ getFile()	Returns all set files
+ getFileInfo()	Retrieve additional internal file informations for files
+ getFileName()	Retrieves the filename of transferred files
+ getFileSize()	Returns the real filesize of the file
+ getFilter()	Retrieve individual filter
+ getFilters()	Returns all set filters
+ getHash()	Returns the hash for a given file
+ getMessages()	Returns found validation messages
+ getMimeType()	Returns the real mimetype of the file
+ getOptions()	Returns set options for adapters or files
+ getPluginLoader()	Retrieve plugin loader for validator or filter chain
+ getTranslator()	Retrieve localization translator object
+ getType()	Returns all set types
+ getValidator()	Retrieve individual validator
+ getValidators()	Returns all set validators
+ hasErrors()	Are there errors registered?
+ hasFilter()	Determine if a given filter has already been registered
+ hasValidator()	Determine if a given validator has already been registered
+ isFiltered()	Has the file been filtered ?
+ isReceived()	Is file received?
+ isSent()	Is file sent?
+ isUploaded()	Has a file been uploaded ?
+ isValid()	Checks if the files are valid
+ receive()	Receive file
+ removeFilter()	Remove an individual filter
+ removeValidator()	Remove an individual validator
+ send()	Send file
+ setDestination()	Sets a new destination for the given files
+ setDisableTranslator()	Indicate whether or not translation should be disabled
+ setFilters()	Sets a filter for the class, erasing all previous set
+ setOptions()	Sets Options for adapters
+ setPluginLoader()	Set plugin loader to use for validator or filter chain
+ setTranslator()	Set translator object for localization
+ setValidators()	Sets a validator for the class, erasing all previous set
+ translatorIsDisabled()	Is translation disabled?

Details

Class constants

FILTER

const FILTER = 'FILTER'

Plugin loader Constants

Defined in Abstract.php, line 35

VALIDATE

const VALIDATE = 'VALIDATE'

Defined in Abstract.php, line 36

Instance fields

$_break

protected $_break = array()

Internal list of breaks

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 44

$_files

protected $_files = array()

Internal list of files
This array looks like this:
array(form => array( - Form is the name within the form or, if not set the filename
name, - Original name of this file
type, - Mime type of this file
size, - Filesize in bytes
tmp_name, - Internalally temporary filename for uploaded files
error, - Error which has occured
destination, - New destination for this file
validators, - Set validator names for this file
files - Set file names for this file
))

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 101

$_filters

protected $_filters = array()

Internal list of filters

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 51

$_loaders

protected $_loaders = array()

Plugin loaders for filter and validation chains

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 58

$_messages

protected $_messages = array()

Internal list of messages

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 65

$_options

protected $_options = array(
        'ignoreNoFile'  => false,
        'useByteString' => true,
        'magicFile'     => null
    )

Available options for file transfers

Defined in File/Transfer/Adapter/Abstract.php, line 112

$_tmpDir

protected $_tmpDir

TMP directory

Var string

Defined in File/Transfer/Adapter/Abstract.php, line 107

$_translator

protected $_translator

Var Zend_Translate

Defined in File/Transfer/Adapter/Abstract.php, line 70

$_translatorDisabled

protected $_translatorDisabled = false

Is translation disabled?

Var bool

Defined in File/Transfer/Adapter/Abstract.php, line 77

$_validators

protected $_validators = array()

Internal list of validators

Var array

Defined in File/Transfer/Adapter/Abstract.php, line 83

Static methods

_toByteString()

protected static function _toByteString( $size)

Returns the formatted size

Parameters

integer $size

Returns string

Defined in File/Transfer/Adapter/Abstract.php, line 1266

getProgress()

public static function getProgress( )

Retrieve progress of transfer

Returns float

Overriden by getProgress() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 171

Instance methods

_filter()

protected function _filter( $files = null)

Internal function to filter all given files

Parameters

string|array $files (Optional) Files to check

Returns boolean False on error

Defined in File/Transfer/Adapter/Abstract.php, line 1282

_getFiles()

protected function _getFiles( $files $names = false $noexception = false)

Returns found files based on internal file array and given files

Parameters

`string\|array $files`	(Optional) Files to return
`boolean $names`	(Optional) Returns only names on true, else complete info
`boolean $noexception`	(Optional) Allows throwing an exception, otherwise returns an empty array

Returns array Found files

Throws Zend_File_Transfer_Exception On false filename

Defined in File/Transfer/Adapter/Abstract.php, line 1396

_getFilterIdentifier()

protected function _getFilterIdentifier( $name)

Retrieve internal identifier for a named filter

Parameters

string $name

Returns string

Defined in File/Transfer/Adapter/Abstract.php, line 1489

_getTmpDir()

protected function _getTmpDir( )

Determine system TMP directory and detect if we have read access

Returns string

Throws Zend_File_Transfer_Exception if unable to determine directory

Defined in File/Transfer/Adapter/Abstract.php, line 1314

_getValidatorIdentifier()

protected function _getValidatorIdentifier( $name)

Retrieve internal identifier for a named validator

Parameters

string $name

Returns string

Defined in File/Transfer/Adapter/Abstract.php, line 1468

_isPathWriteable()

protected function _isPathWriteable( $path)

Tries to detect if we can read and write to the given path

Parameters

string $path

Defined in File/Transfer/Adapter/Abstract.php, line 1367

addFile()

public function addFile( $file $validator = null $filter = null)

Adds one or more files

Parameters

`string\|array $file`	File to add
`string\|array $validator`	Validators to use for this file, must be set before
`string\|array $filter`	Filters to use for this file, must be set before

Returns Zend_File_Transfer_Adapter_Abstract

Throws Zend_File_Transfer_Exception Not implemented

Defined in File/Transfer/Adapter/Abstract.php, line 961

addFilter()

public function addFilter( $filter $options = null $files = null)

Adds a new filter for this class

Parameters

`string\|array $filter`	Type of filter to add
`string\|array $options`	Options to set for the filter
`string\|array $files`	Files to limit this filter to

Returns Zend_File_Transfer_Adapter

Defined in File/Transfer/Adapter/Abstract.php, line 723

addFilters()

public function addFilters( array $filters $files = null)

Add Multiple filters at once

Parameters

`array $filters`
`string\|array $files`

Returns Zend_File_Transfer_Adapter_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 751

addPrefixPath()

public function addPrefixPath( $prefix $path $type = null)

Add prefix path for plugin loader

If no $type specified, assumes it is a base path for both filters and
validators, and sets each according to the following rules:
- filters: $prefix = $prefix . '_Filter'
- validators: $prefix = $prefix . '_Validate'

Otherwise, the path prefix is set on the appropriate plugin loader.

Parameters

`string $prefix`
`string $path`
`string $type`

Returns Zend_File_Transfer_Adapter_Abstract

Throws Zend_File_Transfer_Exception for invalid type

Defined in File/Transfer/Adapter/Abstract.php, line 255

addPrefixPaths()

public function addPrefixPaths( array $spec)

Add many prefix paths at once

Parameters

array $spec

Returns Zend_File_Transfer_Exception

Defined in File/Transfer/Adapter/Abstract.php, line 287

addType()

public function addType( $type $validator = null $filter = null)

Adds one or more type of files

Parameters

`string\|array $type`	Type of files to add
`string\|array $validator`	Validators to use for this file, must be set before
`string\|array $filter`	Filters to use for this file, must be set before

Returns Zend_File_Transfer_Adapter_Abstract

Throws Zend_File_Transfer_Exception Not implemented

Defined in File/Transfer/Adapter/Abstract.php, line 988

addValidator()

public function addValidator( $validator $breakChainOnFailure = false $options = null $files = null)

Adds a new validator for this class

Parameters

`string\|array $validator`	Type of validator to add
`boolean $breakChainOnFailure`	If the validation chain should stop an failure
`string\|array $options`	Options to set for the validator
`string\|array $files`	Files to limit this validator to

Returns Zend_File_Transfer_Adapter

Defined in File/Transfer/Adapter/Abstract.php, line 332

addValidators()

public function addValidators( array $validators $files = null)

Add Multiple validators at once

Parameters

`array $validators`
`string\|array $files`

Returns Zend_File_Transfer_Adapter_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 371

clearFilters()

public function clearFilters( )

Remove all filters

Returns Zend_File_Transfer_Adapter_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 889

clearValidators()

public function clearValidators( )

Remove all validators

Returns Zend_File_Transfer_Adapter_Abstract

Overriden by clearValidators() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 532

getDestination()

public function getDestination( $files = null)

Retrieve destination directory value

Parameters

null|string|array $files

Returns null|string|array

Defined in File/Transfer/Adapter/Abstract.php, line 1041

getErrors()

public function getErrors( )

Retrieve error codes

Returns array

Defined in File/Transfer/Adapter/Abstract.php, line 700

getFile()

public function getFile( )

Returns all set files

Returns array List of set files

Throws Zend_File_Transfer_Exception Not implemented

Defined in File/Transfer/Adapter/Abstract.php, line 904

getFileInfo()

public function getFileInfo( $file = null)

Retrieve additional internal file informations for files

Parameters

string $file (Optional) File to get informations for

Returns array

Defined in File/Transfer/Adapter/Abstract.php, line 947

getFileName()

public function getFileName( $file = null $path = true)

Retrieves the filename of transferred files.

Parameters

`$file`
`boolean $path`	(Optional) Should the path also be returned ?

Returns string|array

Defined in File/Transfer/Adapter/Abstract.php, line 917

getFileSize()

public function getFileSize( $files = null)

Returns the real filesize of the file

Parameters

string|array $files Files to get the filesize from

Returns string|array Filesize

Throws Zend_File_Transfer_Exception When the file does not exist

Defined in File/Transfer/Adapter/Abstract.php, line 1174

getFilter()

public function getFilter( $name)

Retrieve individual filter

Parameters

string $name

Returns Zend_Filter_Interface|null

Defined in File/Transfer/Adapter/Abstract.php, line 818

getFilters()

public function getFilters( $files = null)

Returns all set filters

Parameters

string|array $files (Optional) Returns the filter for this files

Returns array List of set filters

Throws Zend_File_Transfer_Exception When file not found

Defined in File/Transfer/Adapter/Abstract.php, line 833

getHash()

public function getHash( $hash = 'crc32' $files = null)

Returns the hash for a given file

Parameters

`string $hash`	Hash algorithm to use
`string\|array $files`	Files to return the hash for

Returns string|array Hashstring

Throws Zend_File_Transfer_Exception On unknown hash algorithm

Defined in File/Transfer/Adapter/Abstract.php, line 1140

getMessages()

public function getMessages( )

Returns found validation messages

Returns array

Defined in File/Transfer/Adapter/Abstract.php, line 690

getMimeType()

public function getMimeType( $files = null)

Returns the real mimetype of the file
Uses fileinfo, when not available mime_magic and as last fallback a manual given mimetype

Parameters

string|array $files Files to get the mimetype from

Returns string|array MimeType

Throws Zend_File_Transfer_Exception When the file does not exist

Defined in File/Transfer/Adapter/Abstract.php, line 1210

getOptions()

public function getOptions( $files = null)

Returns set options for adapters or files

Parameters

array $files (Optional) Files to return the options for

Returns array Options for given files

Defined in File/Transfer/Adapter/Abstract.php, line 582

getPluginLoader()

public function getPluginLoader( $type)

Retrieve plugin loader for validator or filter chain

Instantiates with default rules if none available for that type. Use
'filter' or 'validate' for $type.

Parameters

string $type

Returns Zend_Loader_PluginLoader

Throws Zend_File_Transfer_Exception on invalid type.

Defined in File/Transfer/Adapter/Abstract.php, line 209

getTranslator()

public function getTranslator( )

Retrieve localization translator object

Returns Zend_Translate_Adapter|null

Defined in File/Transfer/Adapter/Abstract.php, line 1101

getType()

public function getType( )

Returns all set types

Returns array List of set types

Throws Zend_File_Transfer_Exception Not implemented

Defined in File/Transfer/Adapter/Abstract.php, line 973

getValidator()

public function getValidator( $name)

Retrieve individual validator

Parameters

string $name

Returns Zend_Validate_Interface|null

Defined in File/Transfer/Adapter/Abstract.php, line 459

getValidators()

public function getValidators( $files = null)

Returns all set validators

Parameters

string|array $files (Optional) Returns the validator for this files

Returns null|array List of set validators

Defined in File/Transfer/Adapter/Abstract.php, line 473

hasErrors()

public function hasErrors( )

Are there errors registered?

Returns boolean

Defined in File/Transfer/Adapter/Abstract.php, line 710

hasFilter()

public function hasFilter( $name)

Determine if a given filter has already been registered

Parameters

string $name

Returns bool

Defined in File/Transfer/Adapter/Abstract.php, line 807

hasValidator()

public function hasValidator( $name)

Determine if a given validator has already been registered

Parameters

string $name

Returns bool

Defined in File/Transfer/Adapter/Abstract.php, line 448

isFiltered()

abstract public function isFiltered( $files = null)

Has the file been filtered ?

Parameters

array|string|null $files

Returns bool

Overriden by isFiltered() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 164

isReceived()

abstract public function isReceived( $files = null)

Is file received?

Parameters

array|string|null $files

Returns bool

Overriden by isReceived() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 148

isSent()

abstract public function isSent( $files = null)

Is file sent?

Parameters

array|string|null $files

Returns bool

Overriden by isSent() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 140

isUploaded()

abstract public function isUploaded( $files = null)

Has a file been uploaded ?

Parameters

array|string|null $files

Returns bool

Overriden by isUploaded() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 156

isValid()

public function isValid( $files = null)

Checks if the files are valid

Parameters

string|array $files (Optional) Files to check

Returns boolean True if all checks are valid

Overriden by isValid() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 602

receive()

abstract public function receive( $options = null)

Receive file

Parameters

mixed $options

Returns bool

Overriden by receive() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 132

removeFilter()

public function removeFilter( $name)

Remove an individual filter

Parameters

string $name

Returns Zend_File_Transfer_Adapter_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 862

removeValidator()

public function removeValidator( $name)

Remove an individual validator

Parameters

string $name

Returns Zend_File_Transfer_Adapter_Abstract

Overriden by removeValidator() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 503

send()

abstract public function send( $options = null)

Send file

Parameters

mixed $options

Returns bool

Overriden by send() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 124

setDestination() Deprecated

public function setDestination( $destination $files = null)

Sets a new destination for the given files

Parameters

`string $destination`	New destination directory
`string\|array $files`	Files to set the new destination for

Returns Zend_File_Transfer_Abstract

Throws Zend_File_Transfer_Exception when the given destination is not a directory or does not exist

Defined in File/Transfer/Adapter/Abstract.php, line 1003

setDisableTranslator()

public function setDisableTranslator( $flag)

Indicate whether or not translation should be disabled

Parameters

bool $flag

Returns Zend_File_Transfer_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 1116

setFilters()

public function setFilters( array $filters $files = null)

Sets a filter for the class, erasing all previous set

Parameters

`array $filters`
`string\|array $files`	Files to limit this filter to

Returns Zend_File_Transfer_Adapter

Defined in File/Transfer/Adapter/Abstract.php, line 795

setOptions()

public function setOptions( $options = array() $files = null)

Sets Options for adapters

Parameters

`array $options`	Options to set
`array $files`	(Optional) Files to set the options for

Defined in File/Transfer/Adapter/Abstract.php, line 549

setPluginLoader()

public function setPluginLoader( Zend_Loader_PluginLoader_Interface $loader $type)

Set plugin loader to use for validator or filter chain

Parameters

`Zend_Loader_PluginLoader_Interface $loader`
`string $type`	'filter', or 'validate'

Returns Zend_File_Transfer_Adapter_Abstract

Throws Zend_File_Transfer_Exception on invalid type

Defined in File/Transfer/Adapter/Abstract.php, line 185

setTranslator()

public function setTranslator( $translator = null)

Set translator object for localization

Parameters

Zend_Translate|null $translator

Returns Zend_File_Transfer_Abstract

Defined in File/Transfer/Adapter/Abstract.php, line 1080

setValidators()

public function setValidators( array $validators $files = null)

Sets a validator for the class, erasing all previous set

Parameters

`array $validators`
`string\|array $files`	Files to limit this validator to

Returns Zend_File_Transfer_Adapter

Overriden by setValidators() in class : Zend_File_Transfer_Adapter_Http

Defined in File/Transfer/Adapter/Abstract.php, line 436

translatorIsDisabled()

public function translatorIsDisabled( )

Is translation disabled?

Returns bool

Defined in File/Transfer/Adapter/Abstract.php, line 1127