File/Transfer/Adapter/Abstract.php

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_File_Transfer
version: $Id: Abstract.php 22372 2010-06-04 20:17:58Z thomas $
Classes: Zend_File_Transfer_Adapter_Abstract

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_File_Transfer_Adapter_Abstract
jump to top

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_File_Transfer
Constants: FILTER; VALIDATE
Properties: $_break; $_filters; $_loaders; $_messages; $_translator; $_translatorDisabled; $_validators; $_files; $_tmpDir; $_options
Methods: send; receive; isSent; isReceived; isUploaded; isFiltered; getProgress; setPluginLoader; getPluginLoader; addPrefixPath; addPrefixPaths; addValidator; addValidators; setValidators; hasValidator; getValidator; getValidators; removeValidator; clearValidators; setOptions; getOptions; isValid; getMessages; getErrors; hasErrors; addFilter; addFilters; setFilters; hasFilter; getFilter; getFilters; removeFilter; clearFilters; getFile; getFileName; getFileInfo; addFile; getType; addType; setDestination; getDestination; setTranslator; getTranslator; setDisableTranslator; translatorIsDisabled; getHash; getFileSize; _detectFileSize; getMimeType; _detectMimeType; _toByteString; _filter; _getTmpDir; _isPathWriteable; _getFiles; _getValidatorIdentifier; _getFilterIdentifier

Description

Abstract class for file transfers (Downloads and Uploads)

Constants

FILTER
jump to class

 FILTER = 'FILTER'

Details

value: FILTER

VALIDATE
jump to class

 VALIDATE = 'VALIDATE'

Details

value: VALIDATE

Properties

$_break
jump to class

array $_break = 'array'

Internal list of breaks

Details

$_break: array
visibility: protected
default: array
final: false
static: false

$_files
jump to class

array $_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 ))

Details

$_files: array
visibility: protected
default: array
final: false
static: false

$_filters
jump to class

array $_filters = 'array'

Internal list of filters

Details

$_filters: array
visibility: protected
default: array
final: false
static: false

$_loaders
jump to class

array $_loaders = 'array'

Plugin loaders for filter and validation chains

Details

$_loaders: array
visibility: protected
default: array
final: false
static: false

$_messages
jump to class

array $_messages = 'array'

Internal list of messages

Details

$_messages: array
visibility: protected
default: array
final: false
static: false

$_options
jump to class

$_options = 'array'

Available options for file transfers

Details

visibility: protected
default: array
final: false
static: false

$_tmpDir
jump to class

string $_tmpDir = ''

TMP directory

Details

$_tmpDir: string
visibility: protected
default
final: false
static: false

$_translator
jump to class

Zend_Translate $_translator = ''

Details

$_translator: Zend_Translate
visibility: protected
default
final: false
static: false

$_translatorDisabled
jump to class

bool $_translatorDisabled = 'false'

Is translation disabled?

Details

$_translatorDisabled: bool
visibility: protected
default: false
final: false
static: false

$_validators
jump to class

array $_validators = 'array'

Internal list of validators

Details

$_validators: array
visibility: protected
default: array
final: false
static: false

Methods

_detectFileSize
jump to class

_detectFileSize(
          array $value
          )
        
        :
        string

Internal method to detect the size of a file

Arguments

$value: array
File infos

Output

string: Filesize of given file

Details

visibility: protected
final: false
static: false

_detectMimeType
jump to class

_detectMimeType(
          array $value
          )
        
        :
        string

Internal method to detect the mime type of a file

Arguments

$value: array
File infos

Output

string: Mimetype of given file

Details

visibility: protected
final: false
static: false

_filter
jump to class

_filter(
          string|array $files
              =
              null
          )
        
        :
        boolean

Internal function to filter all given files

Arguments

$files: stringarray
(Optional) Files to check

Output

boolean: False on error

Details

visibility: protected
final: false
static: false

_getFiles
jump to class

_getFiles(
          string|array $files, boolean $names
              =
              false, boolean $noexception
              =
              false
          )
        
        :
        array

Returns found files based on internal file array and given files

Arguments

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

Output

array: Found files

Details

visibility: protected
final: false
static: false
throws: On false filename

_getFilterIdentifier
jump to class

_getFilterIdentifier(
          string $name
          )
        
        :
        string

Retrieve internal identifier for a named filter

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

_getTmpDir
jump to class

_getTmpDir(
          
          )
        
        :
        string

Determine system TMP directory and detect if we have read access

Output

string

Details

visibility: protected
final: false
static: false
throws: if unable to determine directory

_getValidatorIdentifier
jump to class

_getValidatorIdentifier(
          string $name
          )
        
        :
        string

Retrieve internal identifier for a named validator

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

_isPathWriteable
jump to class

_isPathWriteable(
          string $path
          )
        
        :

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

Arguments

$path: string

Details

visibility: protected
final: false
static: false

_toByteString
jump to class

_toByteString(
          integer $size
          )
        
        :
        string

Returns the formatted size

Arguments

$size: integer

Output

string

Details

visibility: protected
final: false
static: true

addFile
jump to class

addFile(
          string|array $file, string|array $validator
              =
              null, string|array $filter
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Adds one or more files

Arguments

$file: stringarray
File to add
$validator: stringarray
Validators to use for this file, must be set before
$filter: stringarray
Filters to use for this file, must be set before

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false
throws: Not implemented

addFilter
jump to class

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

Adds a new filter for this class

Arguments

$filter: stringarray
Type of filter to add
$options: stringarray
Options to set for the filter
$files: stringarray
Files to limit this filter to

Output

Zend_File_Transfer_Adapter

Details

visibility: public
final: false
static: false

addFilters
jump to class

addFilters(
          array $filters, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Add Multiple filters at once

Arguments

$filters: array
$files: stringarray

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

addPrefixPath
jump to class

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

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.

Arguments

$prefix: string
$path: string
$type: string

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false
throws: for invalid type

addPrefixPaths
jump to class

addPrefixPaths(
          array $spec
          )
        
        :
        Zend_File_Transfer_Exception

Add many prefix paths at once

Arguments

$spec: array

Output

Zend_File_Transfer_Exception

Details

visibility: public
final: false
static: false

addType
jump to class

addType(
          string|array $type, string|array $validator
              =
              null, string|array $filter
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Adds one or more type of files

Arguments

$type: stringarray
Type of files to add
$validator: stringarray
Validators to use for this file, must be set before
$filter: stringarray
Filters to use for this file, must be set before

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false
throws: Not implemented

addValidator
jump to class

addValidator(
          string|array $validator, boolean $breakChainOnFailure
              =
              false, string|array $options
              =
              null, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter

Adds a new validator for this class

Arguments

$validator: stringarray
Type of validator to add
$breakChainOnFailure: boolean
If the validation chain should stop an failure
$options: stringarray
Options to set for the validator
$files: stringarray
Files to limit this validator to

Output

Zend_File_Transfer_Adapter

Details

visibility: public
final: false
static: false

addValidators
jump to class

addValidators(
          array $validators, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Add Multiple validators at once

Arguments

$validators: array
$files: stringarray

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

clearFilters
jump to class

clearFilters(
          
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Remove all filters

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

clearValidators
jump to class

clearValidators(
          
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Remove all validators

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

getDestination
jump to class

getDestination(
          null|string|array $files
              =
              null
          )
        
        :
        null|string|array

Retrieve destination directory value

Arguments

$files: nullstringarray

Output

null|string|array

Details

visibility: public
final: false
static: false

getErrors
jump to class

getErrors(
          
          )
        
        :
        array

Retrieve error codes

Output

array

Details

visibility: public
final: false
static: false

getFile
jump to class

getFile(
          
          )
        
        :
        array

Returns all set files

Output

array: List of set files

Details

visibility: public
final: false
static: false
throws: Not implemented

getFileInfo
jump to class

getFileInfo(
          string $file
              =
              null
          )
        
        :
        array

Retrieve additional internal file informations for files

Arguments

$file: string
(Optional) File to get informations for

Output

array

Details

visibility: public
final: false
static: false

getFileName
jump to class

getFileName(
           $file
              =
              null, boolean $path
              =
              true
          )
        
        :
        string|array

Retrieves the filename of transferred files.

Arguments

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

Output

string|array

Details

visibility: public
final: false
static: false

getFileSize
jump to class

getFileSize(
          string|array $files
              =
              null
          )
        
        :
        string|array

Returns the real filesize of the file

Arguments

$files: stringarray
Files to get the filesize from

Output

string|array: Filesize

Details

visibility: public
final: false
static: false
throws: When the file does not exist

getFilter
jump to class

getFilter(
          string $name
          )
        
        :
        Zend_Filter_Interface|null

Retrieve individual filter

Arguments

$name: string

Output

Zend_Filter_Interface|null

Details

visibility: public
final: false
static: false

getFilters
jump to class

getFilters(
          string|array $files
              =
              null
          )
        
        :
        array

Returns all set filters

Arguments

$files: stringarray
(Optional) Returns the filter for this files

Output

array: List of set filters

Details

visibility: public
final: false
static: false
throws: When file not found

getHash
jump to class

getHash(
          string $hash
              =
              crc32, string|array $files
              =
              null
          )
        
        :
        string|array

Returns the hash for a given file

Arguments

$hash: string
Hash algorithm to use
$files: stringarray
Files to return the hash for

Output

string|array: Hashstring

Details

visibility: public
final: false
static: false
throws: On unknown hash algorithm

getMessages
jump to class

getMessages(
          
          )
        
        :
        array

Returns found validation messages

Output

array

Details

visibility: public
final: false
static: false

getMimeType
jump to class

getMimeType(
          string|array $files
              =
              null
          )
        
        :
        string|array

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

Arguments

$files: stringarray
Files to get the mimetype from

Output

string|array: MimeType

Details

visibility: public
final: false
static: false
throws: When the file does not exist

getOptions
jump to class

getOptions(
          array $files
              =
              null
          )
        
        :
        array

Returns set options for adapters or files

Arguments

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

Output

array: Options for given files

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

getPluginLoader(
          string $type
          )
        
        :
        Zend_Loader_PluginLoader

Retrieve plugin loader for validator or filter chain

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

Arguments

$type: string

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false
throws: on invalid type.

getProgress
jump to class

getProgress(
          
          )
        
        :
        float

Retrieve progress of transfer

Output

float

Details

visibility: public
final: false
static: true

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

getType
jump to class

getType(
          
          )
        
        :
        array

Returns all set types

Output

array: List of set types

Details

visibility: public
final: false
static: false
throws: Not implemented

getValidator
jump to class

getValidator(
          string $name
          )
        
        :
        Zend_Validate_Interface|null

Retrieve individual validator

Arguments

$name: string

Output

Zend_Validate_Interface|null

Details

visibility: public
final: false
static: false

getValidators
jump to class

getValidators(
          string|array $files
              =
              null
          )
        
        :
        null|array

Returns all set validators

Arguments

$files: stringarray
(Optional) Returns the validator for this files

Output

null|array: List of set validators

Details

visibility: public
final: false
static: false

hasErrors
jump to class

hasErrors(
          
          )
        
        :
        boolean

Are there errors registered?

Output

boolean

Details

visibility: public
final: false
static: false

hasFilter
jump to class

hasFilter(
          string $name
          )
        
        :
        bool

Determine if a given filter has already been registered

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

hasValidator
jump to class

hasValidator(
          string $name
          )
        
        :
        bool

Determine if a given validator has already been registered

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

isFiltered
jump to class

isFiltered(
          array|string|null $files
              =
              null
          )
        
        :
        bool

Has the file been filtered ?

Arguments

$files: arraystringnull

Output

bool

Details

visibility: public
final: false
static: false

isReceived
jump to class

isReceived(
          array|string|null $files
              =
              null
          )
        
        :
        bool

Is file received?

Arguments

$files: arraystringnull

Output

bool

Details

visibility: public
final: false
static: false

isSent
jump to class

isSent(
          array|string|null $files
              =
              null
          )
        
        :
        bool

Is file sent?

Arguments

$files: arraystringnull

Output

bool

Details

visibility: public
final: false
static: false

isUploaded
jump to class

isUploaded(
          array|string|null $files
              =
              null
          )
        
        :
        bool

Has a file been uploaded ?

Arguments

$files: arraystringnull

Output

bool

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          string|array $files
              =
              null
          )
        
        :
        boolean

Checks if the files are valid

Arguments

$files: stringarray
(Optional) Files to check

Output

boolean: True if all checks are valid

Details

visibility: public
final: false
static: false

receive
jump to class

receive(
          mixed $options
              =
              null
          )
        
        :
        bool

Receive file

Arguments

$options: mixed

Output

bool

Details

visibility: public
final: false
static: false

removeFilter
jump to class

removeFilter(
          string $name
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Remove an individual filter

Arguments

$name: string

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

removeValidator
jump to class

removeValidator(
          string $name
          )
        
        :
        Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Arguments

$name: string

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false

send
jump to class

send(
          mixed $options
              =
              null
          )
        
        :
        bool

Send file

Arguments

$options: mixed

Output

bool

Details

visibility: public
final: false
static: false

setDestination
jump to class

setDestination(
          string $destination, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Abstract

Sets a new destination for the given files

Arguments

$destination: string
New destination directory
$files: stringarray
Files to set the new destination for

Output

Zend_File_Transfer_Abstract

Details

visibility: public
final: false
static: false
deprecated: Will be changed to be a filter!!!
throws: when the given destination is not a directory or does not exist

setDisableTranslator
jump to class

setDisableTranslator(
          bool $flag
          )
        
        :
        Zend_File_Transfer_Abstract

Indicate whether or not translation should be disabled

Arguments

$flag: bool

Output

Zend_File_Transfer_Abstract

Details

visibility: public
final: false
static: false

setFilters
jump to class

setFilters(
           $filters, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter

Sets a filter for the class, erasing all previous set

Arguments

$filters
$files: stringarray
Files to limit this filter to

Output

Zend_File_Transfer_Adapter

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
              =
              array, array $files
              =
              null
          )
        
        :

Sets Options for adapters

Arguments

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

Details

visibility: public
final: false
static: false

setPluginLoader
jump to class

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

Set plugin loader to use for validator or filter chain

Arguments

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

Output

Zend_File_Transfer_Adapter_Abstract

Details

visibility: public
final: false
static: false
throws: on invalid type

setTranslator
jump to class

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

Set translator object for localization

Arguments

$translator: Zend_Translatenull

Output

Zend_File_Transfer_Abstract

Details

visibility: public
final: false
static: false

setValidators
jump to class

setValidators(
           $validators, string|array $files
              =
              null
          )
        
        :
        Zend_File_Transfer_Adapter

Sets a validator for the class, erasing all previous set

Arguments

$validators
$files: stringarray
Files to limit this validator to

Output

Zend_File_Transfer_Adapter

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

API Documentation

File/Transfer/Adapter/Abstract.php

Description

Zend_File_Transfer_Adapter_Abstractjump to top

Description

Constants

FILTERjump to class

Details

VALIDATEjump to class

Details

Properties

$_breakjump to class

Details

$_filesjump to class

Details

$_filtersjump to class

Details

$_loadersjump to class

Details

$_messagesjump to class

Details

$_optionsjump to class

Details

$_tmpDirjump to class

Details

$_translatorjump to class

Details

$_translatorDisabledjump to class

Details

$_validatorsjump to class

Details

Methods

_detectFileSizejump to class

Arguments

Output

Details

_detectMimeTypejump to class

Arguments

Output

Details

_filterjump to class

Arguments

Output

Details

_getFilesjump to class

Arguments

Output

Details

_getFilterIdentifierjump to class

Arguments

Output

Details

_getTmpDirjump to class

Output

Details

_getValidatorIdentifierjump to class

Arguments

Output

Details

_isPathWriteablejump to class

Arguments

Details

_toByteStringjump to class

Arguments

Output

Details

addFilejump to class

Arguments

Output

Details

addFilterjump to class

Arguments

Output

Details

addFiltersjump to class

Arguments

Output

Details

addPrefixPathjump to class

Arguments

Zend_File_Transfer_Adapter_Abstract
jump to top

FILTER
jump to class

VALIDATE
jump to class

$_break
jump to class

$_files
jump to class

$_filters
jump to class

$_loaders
jump to class

$_messages
jump to class

$_options
jump to class

$_tmpDir
jump to class

$_translator
jump to class

$_translatorDisabled
jump to class

$_validators
jump to class

_detectFileSize
jump to class

_detectMimeType
jump to class

_filter
jump to class

_getFiles
jump to class

_getFilterIdentifier
jump to class

_getTmpDir
jump to class

_getValidatorIdentifier
jump to class

_isPathWriteable
jump to class

_toByteString
jump to class

addFile
jump to class

addFilter
jump to class

addFilters
jump to class

addPrefixPath
jump to class

addPrefixPaths
jump to class

addType
jump to class

addValidator
jump to class

addValidators
jump to class

clearFilters
jump to class

clearValidators
jump to class

getDestination
jump to class

getErrors
jump to class

getFile
jump to class

getFileInfo
jump to class

getFileName
jump to class

getFileSize
jump to class

getFilter
jump to class

getFilters
jump to class

getHash
jump to class

getMessages
jump to class

getMimeType
jump to class

getOptions
jump to class

getPluginLoader
jump to class