API Documentation

File/Transfer/Adapter/Http.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_File_Transfer  
version
$Id: Http.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_File_Transfer_Adapter_Http

File transfer adapter class for the HTTP protocol

Extends from
\Zend_File_Transfer_Adapter_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_File_Transfer  

Properties

Propertyprotected  $_callbackApc= 'apc_fetch'
static
Default valueapc_fetchDetails
Type
Propertyprotected  $_callbackUploadProgress= 'uploadprogress_get_info'
static
Default valueuploadprogress_get_infoDetails
Type

Methods

methodpublic__construct( array $options = array ) : void

Constructor for Http File Transfers

Parameters
Name Type Description
$options array OPTIONAL Options to set
methodprotected_detectFileSize( array $value ) : string

Internal method to detect the size of a file

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_detectFileSize()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_detectMimeType()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_filter()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_getFiles()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_getFilterIdentifier()
Parameters
Name Type Description
$name string
Returns
Type Description
string
methodprotected_getTmpDir( ) : string

Determine system TMP directory and detect if we have read access

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_getTmpDir()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_getValidatorIdentifier()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_isPathWriteable()
Parameters
Name Type Description
$path string
methodprotected_prepareFiles( ) : array

Prepare the $_FILES array to match the internal syntax of one file per entry

Returns
Type Description
array
methodprotected_toByteString( integer $size ) : string
static

Returns the formatted size

Inherited from: \Zend_File_Transfer_Adapter_Abstract::_toByteString()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addFile()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addFilter()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addFilters()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addPrefixPath()

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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addPrefixPaths()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addType()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addValidator()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::addValidators()
Parameters
Name Type Description
$validators array
$files string|array
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicclearValidators( ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

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

Retrieve destination directory value

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getDestination()
Parameters
Name Type Description
$files null|string|array
Returns
Type Description
nullstringarray
methodpublicgetErrors( ) : array

Retrieve error codes

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getErrors()
Returns
Type Description
array
methodpublicgetFile( ) : array

Returns all set files

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFile()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFileInfo()
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.

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFileName()
Parameters
Name Type Description
$file
$path boolean

(Optional) Should the path also be returned ?

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

Returns the real filesize of the file

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFileSize()
Parameters
Name Type Description
$files string|array Files to get the filesize from
Returns
Type Description
stringarray Filesize
Throws
Exception Description
\Zend_File_Transfer_Exception When the file does not exist
methodpublicgetFilter( string $name ) : \Zend_Filter_Interface|null

Retrieve individual filter

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFilter()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Filter_Interfacenull
methodpublicgetFilters( string|array $files = null ) : array

Returns all set filters

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getFilters()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getHash()
Parameters
Name Type Description
$hash string Hash algorithm to use
$files string|array Files to return the hash for
Returns
Type Description
stringarray Hashstring
Throws
Exception Description
\Zend_File_Transfer_Exception On unknown hash algorithm
methodpublicgetMessages( ) : array

Returns found validation messages

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getMessages()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getMimeType()
Parameters
Name Type Description
$files string|array Files to get the mimetype from
Returns
Type Description
stringarray 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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getOptions()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getPluginLoader()

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( string $id = null ) : array|null
static

Returns the actual progress of file up-/downloads

Parameters
Name Type Description
$id string The upload to get the progress for
Returns
Type Description
arraynull
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Retrieve localization translator object

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetType( ) : array

Returns all set types

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getType()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getValidator()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Validate_Interfacenull
methodpublicgetValidators( string|array $files = null ) : null|array

Returns all set validators

Inherited from: \Zend_File_Transfer_Adapter_Abstract::getValidators()
Parameters
Name Type Description
$files string|array

(Optional) Returns the validator for this files

Returns
Type Description
nullarray List of set validators
methodpublichasErrors( ) : boolean

Are there errors registered?

Inherited from: \Zend_File_Transfer_Adapter_Abstract::hasErrors()
Returns
Type Description
boolean
methodpublichasFilter( string $name ) : bool

Determine if a given filter has already been registered

Inherited from: \Zend_File_Transfer_Adapter_Abstract::hasFilter()
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublichasValidator( string $name ) : bool

Determine if a given validator has already been registered

Inherited from: \Zend_File_Transfer_Adapter_Abstract::hasValidator()
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublicisApcAvailable( ) : boolean
static

Checks the APC extension for progress information

Returns
Type Description
boolean
methodpublicisFiltered( string|array $files = null ) : bool

Checks if the file was already filtered

Parameters
Name Type Description
$files string|array

(Optional) Files to check

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

Checks if the file was already received

Parameters
Name Type Description
$files string|array

(Optional) Files to check

Returns
Type Description
bool
methodpublicisSent(  $files = null ) : bool

Checks if the file was already sent

Parameters
Name Type Description
$files
Returns
Type Description
bool
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicisUploadProgressAvailable( ) : boolean
static

Checks the UploadProgress extension for progress information

Returns
Type Description
boolean
methodpublicisUploaded(  $files = null ) : bool

Has a file been uploaded ?

Parameters
Name Type Description
$files
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( string|array $files = null ) : bool

Receive the file from the client (Upload)

Parameters
Name Type Description
$files string|array

(Optional) Files to receive

Returns
Type Description
bool
methodpublicremoveFilter( string $name ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual filter

Inherited from: \Zend_File_Transfer_Adapter_Abstract::removeFilter()
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( string|array $options = null ) : void

Send the file to the client (Download)

Parameters
Name Type Description
$options string|array

Options for the file(s) to send

Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicsetDestination( string $destination, string|array $files = null ) : \Zend_File_Transfer_Abstract

Sets a new destination for the given files

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setDestination()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setDisableTranslator()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setFilters()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setOptions()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setPluginLoader()
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

Inherited from: \Zend_File_Transfer_Adapter_Abstract::setTranslator()
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?

Inherited from: \Zend_File_Transfer_Adapter_Abstract::translatorIsDisabled()
Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.