API Documentation

Zend/File/Transfer/Adapter/Abstract.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_File_Transfer  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_File_Transfer_Adapter_Abstract

Package: Zend\File\Transfer

Abstract class for file transfers (Downloads and Uploads)

Children
\Zend_File_Transfer_Adapter_Http
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  FILTER = 'FILTER'
Constant  VALIDATE = 'VALIDATE'

Properties

Propertyprotectedarray  $_break= 'array()'

Internal list of breaks

Default valuearray()Details
Type
array
Propertyprotectedarray  $_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 ))

Default valuearray()Details
Type
array
Propertyprotectedarray  $_filters= 'array()'

Internal list of filters

Default valuearray()Details
Type
array
Propertyprotectedarray  $_loaders= 'array()'

Plugin loaders for filter and validation chains

Default valuearray()Details
Type
array
Propertyprotectedarray  $_messages= 'array()'

Internal list of messages

Default valuearray()Details
Type
array
Propertyprotected  $_options= 'array( 'ignoreNoFile' => false'

Available options for file transfers

Default valuearray( 'ignoreNoFile' => falseDetails
Type
Propertyprotectedstring  $_tmpDir= ''

TMP directory

Details
Type
string
Propertyprotected\Zend_Translate  $_translator= ''

Details
Type
\Zend_Translate
Propertyprotectedbool  $_translatorDisabled= 'false'

Is translation disabled?

Default valuefalseDetails
Type
bool
Propertyprotectedarray  $_validators= 'array()'

Internal list of validators

Default valuearray()Details
Type
array

Methods

methodprotected_detectFileSize( array $value ) : string

Internal method to detect the size of a file

Parameters
Name Type Description
$value array

File infos

Returns
Type Description
string Filesize of given file
methodprotected_detectMimeType( array $value ) : string

Internal method to detect the mime type of a file

Parameters
Name Type Description
$value array

File infos

Returns
Type Description
string Mimetype of given file
methodprotected_filter( string|array $files = null ) : boolean

Internal function to filter all given files

Parameters
Name Type Description
$files string|array

(Optional) Files to check

Returns
Type Description
boolean False on error
methodprotected_getFiles( string|array $files, boolean $names = false, boolean $noexception = false ) : array

Returns found files based on internal file array and given files

Parameters
Name Type Description
$files string|array

(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

Returns
Type Description
array Found files
Throws
Exception Description
\Zend_File_Transfer_Exception On false filename
methodprotected_getFilterIdentifier( string $name ) : string

Retrieve internal identifier for a named filter

Parameters
Name Type Description
$name string
Returns
Type Description
string
methodprotected_getTmpDir( ) : string

Determine system TMP directory and detect if we have read access

Returns
Type Description
string
Throws
Exception Description
\Zend_File_Transfer_Exception if unable to determine directory
methodprotected_getValidatorIdentifier( string $name ) : string

Retrieve internal identifier for a named validator

Parameters
Name Type Description
$name string
Returns
Type Description
string
methodprotected_isPathWriteable( string $path ) : void

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

Parameters
Name Type Description
$path string
methodprotected_toByteString( integer $size ) : string
static

Returns the formatted size

Parameters
Name Type Description
$size integer
Returns
Type Description
string
methodpublicaddFile( string|array $file, string|array $validator = null, string|array $filter = null ) : \Zend_File_Transfer_Adapter_Abstract

Adds one or more files

Parameters
Name Type Description
$file string|array

File to add

$validator string|array

Validators to use for this file, must be set before

$filter string|array

Filters to use for this file, must be set before

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicaddFilter( string|array $filter, string|array $options = null, string|array $files = null ) : \Zend_File_Transfer_Adapter

Adds a new filter for this class

Parameters
Name Type Description
$filter string|array

Type of filter to add

$options string|array

Options to set for the filter

$files string|array

Files to limit this filter to

Returns
Type Description
\Zend_File_Transfer_Adapter
methodpublicaddFilters( array $filters, string|array $files = null ) : \Zend_File_Transfer_Adapter_Abstract

Add Multiple filters at once

Parameters
Name Type Description
$filters array
$files string|array
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicaddPrefixPath( 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.

Parameters
Name Type Description
$prefix string
$path string
$type string
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
Throws
Exception Description
\Zend_File_Transfer_Exception for invalid type
methodpublicaddPrefixPaths( array $spec ) : \Zend_File_Transfer_Exception

Add many prefix paths at once

Parameters
Name Type Description
$spec array
Returns
Type Description
\Zend_File_Transfer_Exception
methodpublicaddType( string|array $type, string|array $validator = null, string|array $filter = null ) : \Zend_File_Transfer_Adapter_Abstract

Adds one or more type of files

Parameters
Name Type Description
$type string|array

Type of files to add

$validator string|array

Validators to use for this file, must be set before

$filter string|array

Filters to use for this file, must be set before

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicaddValidator( 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

Parameters
Name Type Description
$validator string|array

Type of validator to add

$breakChainOnFailure boolean

If the validation chain should stop an failure

$options string|array

Options to set for the validator

$files string|array

Files to limit this validator to

Returns
Type Description
\Zend_File_Transfer_Adapter
methodpublicaddValidators( array $validators, string|array $files = null ) : \Zend_File_Transfer_Adapter_Abstract

Add Multiple validators at once

Parameters
Name Type Description
$validators array
$files string|array
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicclearFilters( ) : \Zend_File_Transfer_Adapter_Abstract

Remove all filters

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicclearValidators( ) : \Zend_File_Transfer_Adapter_Abstract

Remove all validators

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicgetDestination( null|string|array $files = null ) : null|string|array

Retrieve destination directory value

Parameters
Name Type Description
$files null|string|array
Returns
Type Description
null|string|array
methodpublicgetErrors( ) : array

Retrieve error codes

Returns
Type Description
array
methodpublicgetFile( ) : array

Returns all set files

Returns
Type Description
array List of set files
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicgetFileInfo( string $file = null ) : array

Retrieve additional internal file informations for files

Parameters
Name Type Description
$file string

(Optional) File to get informations for

Returns
Type Description
array
methodpublicgetFileName(  $file = null, boolean $path = true ) : string|array

Retrieves the filename of transferred files.

Parameters
Name Type Description
$file
$path boolean

(Optional) Should the path also be returned ?

Returns
Type Description
string|array
methodpublicgetFileSize( string|array $files = null ) : string|array

Returns the real filesize of the file

Parameters
Name Type Description
$files string|array

Files to get the filesize from

Returns
Type Description
string|array Filesize
Throws
Exception Description
\Zend_File_Transfer_Exception When the file does not exist
methodpublicgetFilter( string $name ) : \Zend_Filter_Interface|null

Retrieve individual filter

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Filter_Interface|null
methodpublicgetFilters( string|array $files = null ) : array

Returns all set filters

Parameters
Name Type Description
$files string|array

(Optional) Returns the filter for this files

Returns
Type Description
array List of set filters
Throws
Exception Description
\Zend_File_Transfer_Exception When file not found
methodpublicgetHash( string $hash = 'crc32', string|array $files = null ) : string|array

Returns the hash for a given file

Parameters
Name Type Description
$hash string

Hash algorithm to use

$files string|array

Files to return the hash for

Returns
Type Description
string|array Hashstring
Throws
Exception Description
\Zend_File_Transfer_Exception On unknown hash algorithm
methodpublicgetMessages( ) : array

Returns found validation messages

Returns
Type Description
array
methodpublicgetMimeType( 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

Parameters
Name Type Description
$files string|array

Files to get the mimetype from

Returns
Type Description
string|array MimeType
Throws
Exception Description
\Zend_File_Transfer_Exception When the file does not exist
methodpublicgetOptions( array $files = null ) : array

Returns set options for adapters or files

Parameters
Name Type Description
$files array

(Optional) Files to return the options for

Returns
Type Description
array Options for given files
methodpublicgetPluginLoader( 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.

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Loader_PluginLoader
Throws
Exception Description
\Zend_File_Transfer_Exception on invalid type.
methodpublicgetProgress( ) : float
static

Retrieve progress of transfer

Returns
Type Description
float
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Retrieve localization translator object

Returns
Type Description
\Zend_Translate_Adapter|null
methodpublicgetType( ) : array

Returns all set types

Returns
Type Description
array List of set types
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicgetValidator( string $name ) : \Zend_Validate_Interface|null

Retrieve individual validator

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Validate_Interface|null
methodpublicgetValidators( string|array $files = null ) : null|array

Returns all set validators

Parameters
Name Type Description
$files string|array

(Optional) Returns the validator for this files

Returns
Type Description
null|array List of set validators
methodpublichasErrors( ) : boolean

Are there errors registered?

Returns
Type Description
boolean
methodpublichasFilter( string $name ) : bool

Determine if a given filter has already been registered

Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublichasValidator( string $name ) : bool

Determine if a given validator has already been registered

Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublicisFiltered( array|string|null $files = null ) : bool
abstract

Has the file been filtered ?

Parameters
Name Type Description
$files array|string|null
Returns
Type Description
bool
methodpublicisReceived( array|string|null $files = null ) : bool
abstract

Is file received?

Parameters
Name Type Description
$files array|string|null
Returns
Type Description
bool
methodpublicisSent( array|string|null $files = null ) : bool
abstract

Is file sent?

Parameters
Name Type Description
$files array|string|null
Returns
Type Description
bool
methodpublicisUploaded( array|string|null $files = null ) : bool
abstract

Has a file been uploaded ?

Parameters
Name Type Description
$files array|string|null
Returns
Type Description
bool
methodpublicisValid( string|array $files = null ) : boolean

Checks if the files are valid

Parameters
Name Type Description
$files string|array

(Optional) Files to check

Returns
Type Description
boolean True if all checks are valid
methodpublicreceive( mixed $options = null ) : bool
abstract

Receive file

Parameters
Name Type Description
$options mixed
Returns
Type Description
bool
methodpublicremoveFilter( string $name ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual filter

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicremoveValidator( string $name ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicsend( mixed $options = null ) : bool
abstract

Send file

Parameters
Name Type Description
$options mixed
Returns
Type Description
bool
methodpublicsetDestination( string $destination, string|array $files = null ) : \Zend_File_Transfer_Abstract

Sets a new destination for the given files

Parameters
Name Type Description
$destination string

New destination directory

$files string|array

Files to set the new destination for

Returns
Type Description
\Zend_File_Transfer_Abstract
Throws
Exception Description
\Zend_File_Transfer_Exception when the given destination is not a directory or does not exist
Details
Deprecated
Will be changed to be a filter!!!  
methodpublicsetDisableTranslator( bool $flag ) : \Zend_File_Transfer_Abstract

Indicate whether or not translation should be disabled

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_File_Transfer_Abstract
methodpublicsetFilters(  $filters, string|array $files = null ) : \Zend_File_Transfer_Adapter

Sets a filter for the class, erasing all previous set

Parameters
Name Type Description
$filters
$files string|array

Files to limit this filter to

Returns
Type Description
\Zend_File_Transfer_Adapter
methodpublicsetOptions( array $options = array(), array $files = null ) : void

Sets Options for adapters

Parameters
Name Type Description
$options array

Options to set

$files array

(Optional) Files to set the options for

methodpublicsetPluginLoader( \Zend_Loader_PluginLoader_Interface $loader, string $type ) : \Zend_File_Transfer_Adapter_Abstract

Set plugin loader to use for validator or filter chain

Parameters
Name Type Description
$loader \Zend_Loader_PluginLoader_Interface
$type string

'filter', or 'validate'

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
Throws
Exception Description
\Zend_File_Transfer_Exception on invalid type
methodpublicsetTranslator( \Zend_Translate|null $translator = null ) : \Zend_File_Transfer_Abstract

Set translator object for localization

Parameters
Name Type Description
$translator \Zend_Translate|null
Returns
Type Description
\Zend_File_Transfer_Abstract
methodpublicsetValidators(  $validators, string|array $files = null ) : \Zend_File_Transfer_Adapter

Sets a validator for the class, erasing all previous set

Parameters
Name Type Description
$validators
$files string|array

Files to limit this validator to

Returns
Type Description
\Zend_File_Transfer_Adapter
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.