File/Transfer/Adapter/Abstract.php

Show:

inherited

Classes
- \Zend_File_Transfer_Adapter_Abstract

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_File_Transfer
Version: $Id$

\Zend_File_Transfer_Adapter_Abstract
jump to top

Package: Zend_File_Transfer

Abstract class for file transfers (Downloads and Uploads)

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

Constants

 
                FILTER
                = 'FILTER'

 
                VALIDATE
                = 'VALIDATE'

Properties

array $_break = array()

Internal list of breaks

Default valuearray()Details

Type: array

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 ))

Default valuearray()Details

Type: array

array $_filters = array()

Internal list of filters

Default valuearray()Details

Type: array

array $_loaders = array()

Plugin loaders for filter and validation chains

Default valuearray()Details

Type: array

array $_messages = array()

Internal list of messages

Default valuearray()Details

Type: array

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

Available options for file transfers

Default valuearray('ignoreNoFile' => false, 'useByteString' => true, 'magicFile' => null, 'detectInfos' => true)Details

Type: n/a

string $_tmpDir

TMP directory

Details

Type: string

\Zend_Translate $_translator

Details

Type: \Zend_Translate

bool $_translatorDisabled = false

Is translation disabled?

Default valuefalseDetails

Type: bool

array $_validators = array()

Internal list of validators

Default valuearray()Details

Type: array

Methods

_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

_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

_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

_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

_getFilterIdentifier(string $name) : string

Retrieve internal identifier for a named filter

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

_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

_getValidatorIdentifier(string $name) : string

Retrieve internal identifier for a named validator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

_isPathWriteable(string $path) : bool

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

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
bool

_toByteString(integer $size) : string

static

Returns the formatted size

Parameters

Name	Type	Description
$size	integer

Returns

Type	Description
string

addFile(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

addFilter(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

addFilters(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

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.

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

addPrefixPaths(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

addType(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

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

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

addValidators(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

clearFilters() : \Zend_File_Transfer_Adapter_Abstract

Remove all filters

Returns

Type	Description
\Zend_File_Transfer_Adapter_Abstract

clearValidators() : \Zend_File_Transfer_Adapter_Abstract

Remove all validators

Returns

Type	Description
\Zend_File_Transfer_Adapter_Abstract

getDestination(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

Throws

Exception	Description
\Zend_File_Transfer_Exception

getErrors() : array

Retrieve error codes

Returns

Type	Description
array

getFile() : array

Returns all set files

Returns

Type	Description
array	List of set files

Throws

Exception	Description
\Zend_File_Transfer_Exception	Not implemented

getFileInfo(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

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

Retrieves the filename of transferred files.

Parameters

Name	Type	Description
$file	string \| null
$path	boolean	(Optional) Should the path also be returned ?

Returns

Type	Description
string \| array

getFileSize(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

getFilter(string $name) : \Zend_Filter_Interface | null

Retrieve individual filter

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Filter_Interface \| null

getFilters(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

getHash(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

getMessages() : array

Returns found validation messages

Returns

Type	Description
array

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

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

getOptions(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

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.

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_PluginLoader

Throws

Exception	Description
\Zend_File_Transfer_Exception	on invalid type.

getProgress() : float

static

Retrieve progress of transfer

Returns

Type	Description
float

getTranslator() : \Zend_Translate_Adapter | null

Retrieve localization translator object

Returns

Type	Description
\Zend_Translate_Adapter \| null

getType() : array

Returns all set types

Returns

Type	Description
array	List of set types

Throws

Exception	Description
\Zend_File_Transfer_Exception	Not implemented

getValidator(string $name) : \Zend_Validate_Interface | null

Retrieve individual validator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Validate_Interface \| null

getValidators(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

hasErrors() : boolean

Are there errors registered?

Returns

Type	Description
boolean

hasFilter(string $name) : bool

Determine if a given filter has already been registered

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

hasValidator(string $name) : bool

Determine if a given validator has already been registered

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

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

abstract

Has the file been filtered ?

Parameters

Name	Type	Description
$files	array \| string \| null

Returns

Type	Description
bool

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

abstract

Is file received?

Parameters

Name	Type	Description
$files	array \| string \| null

Returns

Type	Description
bool

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

abstract

Is file sent?

Parameters

Name	Type	Description
$files	array \| string \| null

Returns

Type	Description
bool

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

abstract

Has a file been uploaded ?

Parameters

Name	Type	Description
$files	array \| string \| null

Returns

Type	Description
bool

isValid(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

receive(mixed $options = null) : bool

abstract

Receive file

Parameters

Name	Type	Description
$options	mixed

Returns

Type	Description
bool

removeFilter(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

removeValidator(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

send(mixed $options = null) : bool

abstract

Send file

Parameters

Name	Type	Description
$options	mixed

Returns

Type	Description
bool

setDestination(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!!!

setDisableTranslator(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

setFilters( $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

setOptions(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

setPluginLoader(\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

setTranslator(\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

Throws

Exception	Description
\Zend_File_Transfer_Exception

setValidators( $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

translatorIsDisabled() : bool

Is translation disabled?

Returns

Type	Description
bool

File/Transfer/Adapter/Abstract.php

\Zend_File_Transfer_Adapter_Abstractjump to top

Constants

Properties

Methods

\Zend_File_Transfer_Adapter_Abstract
jump to top