Zend_File_Transfer_Adapter_Abstract Class Reference

Inheritance diagram for Zend_File_Transfer_Adapter_Abstract:

Public Member Functions
	send ($options=null)
	receive ($options=null)
	isSent ($files=null)
	isReceived ($files=null)
	isUploaded ($files=null)
	isFiltered ($files=null)
	setPluginLoader (Zend_Loader_PluginLoader_Interface $loader, $type)
	getPluginLoader ($type)
	addPrefixPath ($prefix, $path, $type=null)
	addPrefixPaths (array $spec)
	addValidator ($validator, $breakChainOnFailure=false, $options=null, $files=null)
	addValidators (array $validators, $files=null)
	setValidators (array $validators, $files=null)
	hasValidator ($name)
	getValidator ($name)
	getValidators ($files=null)
	removeValidator ($name)
	clearValidators ()
	setOptions ($options=array(), $files=null)
	getOptions ($files=null)
	isValid ($files=null)
	getMessages ()
	getErrors ()
	hasErrors ()
	addFilter ($filter, $options=null, $files=null)
	addFilters (array $filters, $files=null)
	setFilters (array $filters, $files=null)
	hasFilter ($name)
	getFilter ($name)
	getFilters ($files=null)
	removeFilter ($name)
	clearFilters ()
	getFile ()
	getFileName ($file=null, $path=true)
	getFileInfo ($file=null)
	addFile ($file, $validator=null, $filter=null)
	getType ()
	addType ($type, $validator=null, $filter=null)
	setDestination ($destination, $files=null)
	getDestination ($files=null)
	setTranslator ($translator=null)
	getTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()
	getHash ($hash='crc32', $files=null)
	getFileSize ($files=null)
	getMimeType ($files=null)

Static Public Member Functions
static	getProgress ()

Data Fields
const	FILTER = 'FILTER'
const	VALIDATE = 'VALIDATE'

Protected Member Functions
	_detectFileSize ($value)
	_detectMimeType ($value)
	_filter ($files=null)
	_getTmpDir ()
	_isPathWriteable ($path)
	_getFiles ($files, $names=false, $noexception=false)
	_getValidatorIdentifier ($name)
	_getFilterIdentifier ($name)

Static Protected Member Functions
static	_toByteString ($size)

Protected Attributes
	$_break = array()
	$_filters = array()
	$_loaders = array()
	$_messages = array()
	$_translator
	$_translatorDisabled = false
	$_validators = array()
	$_files = array()
	$_tmpDir
	$_options

Detailed Description

Definition at line 30 of file Abstract.php.

Member Function Documentation

_detectFileSize()

_detectFileSize (   $value )

protected

Internal method to detect the size of a file

Parameters

array

$value

File infos

Returns

string Filesize of given file

Definition at line 1239 of file Abstract.php.

    {
        if (file_exists($value['name'])) {
            $result = sprintf("%u", @filesize($value['name']));
        } else if (file_exists($value['tmp_name'])) {
            $result = sprintf("%u", @filesize($value['tmp_name']));
        } else {
            return null;
        }

        return $result;
    }

_detectMimeType()

_detectMimeType (   $value )

protected

Internal method to detect the mime type of a file

Parameters

array

$value

File infos

Returns

string Mimetype of given file

Definition at line 1288 of file Abstract.php.

    {
        if (file_exists($value['name'])) {
            $file = $value['name'];
        } else if (file_exists($value['tmp_name'])) {
            $file = $value['tmp_name'];
        } else {
            return null;
        }

        if (class_exists('finfo', false)) {
            $const = defined('FILEINFO_MIME_TYPE') ? FILEINFO_MIME_TYPE : FILEINFO_MIME;
            if (!empty($value['options']['magicFile'])) {
                $mime = @finfo_open($const, $value['options']['magicFile']);
            }

            if (empty($mime)) {
                $mime = @finfo_open($const);
            }

            if (!empty($mime)) {
                $result = finfo_file($mime, $file);
            }

            unset($mime);
        }

        if (empty($result) && (function_exists('mime_content_type')
            && ini_get('mime_magic.magicfile'))) {
            $result = mime_content_type($file);
        }

        if (empty($result)) {
            $result = 'application/octet-stream';
        }

        return $result;
    }

_filter()

_filter (   $files = null )

protected

Internal function to filter all given files

Parameters

string | array

$files

(Optional) Files to check

Returns

boolean False on error

Definition at line 1349 of file Abstract.php.

    {
        $check           = $this->_getFiles($files);
        foreach ($check as $name => $content) {
            if (array_key_exists('filters', $content)) {
                foreach ($content['filters'] as $class) {
                    $filter = $this->_filters[$class];
                    try {
                        $result = $filter->filter($this->getFileName($name));

                        $this->_files[$name]['destination'] = dirname($result);
                        $this->_files[$name]['name']        = basename($result);
                    } catch (Zend_Filter_Exception $e) {
                        $this->_messages += array($e->getMessage());
                    }
                }
            }
        }

        if (count($this->_messages) > 0) {
            return false;
        }

        return true;
    }

_getFiles()

_getFiles (   $files,   $names = false,   $noexception = false  )

protected

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

Exceptions

Zend_File_Transfer_Exception

On false filename

Definition at line 1464 of file Abstract.php.

    {
        $check = array();

        if (is_string($files)) {
            $files = array($files);
        }

        if (is_array($files)) {
            foreach ($files as $find) {
                $found = array();
                foreach ($this->_files as $file => $content) {
                    if (!isset($content['name'])) {
                        continue;
                    }

                    if (($content['name'] === $find) && isset($content['multifiles'])) {
                        foreach ($content['multifiles'] as $multifile) {
                            $found[] = $multifile;
                        }
                        break;
                    }

                    if ($file === $find) {
                        $found[] = $file;
                        break;
                    }

                    if ($content['name'] === $find) {
                        $found[] = $file;
                        break;
                    }
                }

                if (empty($found)) {
                    if ($noexception !== false) {
                        return array();
                    }

                    #require_once 'Zend/File/Transfer/Exception.php';
                    throw new Zend_File_Transfer_Exception(sprintf('The file transfer adapter can not find "%s"', $find));
                }

                foreach ($found as $checked) {
                    $check[$checked] = $this->_files[$checked];
                }
            }
        }

        if ($files === null) {
            $check = $this->_files;
            $keys  = array_keys($check);
            foreach ($keys as $key) {
                if (isset($check[$key]['multifiles'])) {
                    unset($check[$key]);
                }
            }
        }

        if ($names) {
            $check = array_keys($check);
        }

        return $check;
    }

_getFilterIdentifier()

_getFilterIdentifier (   $name )

protected

Retrieve internal identifier for a named filter

Parameters

string

$name

Returns

string

Definition at line 1557 of file Abstract.php.

    {
        if (array_key_exists($name, $this->_filters)) {
            return $name;
        }

        foreach (array_keys($this->_filters) as $test) {
            if (preg_match('/' . preg_quote($name) . '$/i', $test)) {
                return $test;
            }
        }

        return false;
    }

_getTmpDir()

_getTmpDir ( )

protected

Determine system TMP directory and detect if we have read access

Returns

string

Exceptions

Zend_File_Transfer_Exception

if unable to determine directory

Definition at line 1381 of file Abstract.php.

    {
        if (null === $this->_tmpDir) {
            $tmpdir = array();
            if (function_exists('sys_get_temp_dir')) {
                $tmpdir[] = sys_get_temp_dir();
            }

            if (!empty($_ENV['TMP'])) {
                $tmpdir[] = realpath($_ENV['TMP']);
            }

            if (!empty($_ENV['TMPDIR'])) {
                $tmpdir[] = realpath($_ENV['TMPDIR']);
            }

            if (!empty($_ENV['TEMP'])) {
                $tmpdir[] = realpath($_ENV['TEMP']);
            }

            $upload = ini_get('upload_tmp_dir');
            if ($upload) {
                $tmpdir[] = realpath($upload);
            }

            foreach($tmpdir as $directory) {
                if ($this->_isPathWriteable($directory)) {
                    $this->_tmpDir = $directory;
                }
            }

            if (empty($this->_tmpDir)) {
                // Attemp to detect by creating a temporary file
                $tempFile = tempnam(md5(uniqid(rand(), TRUE)), '');
                if ($tempFile) {
                    $this->_tmpDir = realpath(dirname($tempFile));
                    unlink($tempFile);
                } else {
                    #require_once 'Zend/File/Transfer/Exception.php';
                    throw new Zend_File_Transfer_Exception('Could not determine a temporary directory');
                }
            }

            $this->_tmpDir = rtrim($this->_tmpDir, "/\\");
        }
        return $this->_tmpDir;
    }

_getValidatorIdentifier()

_getValidatorIdentifier (   $name )

protected

Retrieve internal identifier for a named validator

Parameters

string

$name

Returns

string

Definition at line 1536 of file Abstract.php.

    {
        if (array_key_exists($name, $this->_validators)) {
            return $name;
        }

        foreach (array_keys($this->_validators) as $test) {
            if (preg_match('/' . preg_quote($name) . '$/i', $test)) {
                return $test;
            }
        }

        return false;
    }

_isPathWriteable()

_isPathWriteable (   $path )

protected

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

Parameters

string

$path

Returns

bool

Definition at line 1435 of file Abstract.php.

    {
        $tempFile = rtrim($path, "/\\");
        $tempFile .= '/' . 'test.1';

        $result = @file_put_contents($tempFile, 'TEST');

        if ($result == false) {
            return false;
        }

        $result = @unlink($tempFile);

        if ($result == false) {
            return false;
        }

        return true;
    }

_toByteString()

static _toByteString (   $size )

staticprotected

Returns the formatted size

Parameters

integer

$size

Returns

string

Definition at line 1333 of file Abstract.php.

    {
        $sizes = array('B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');
        for ($i=0; $size >= 1024 && $i < 9; $i++) {
            $size /= 1024;
        }

        return round($size, 2) . $sizes[$i];
    }

addFile()

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

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 988 of file Abstract.php.

    {
        #require_once 'Zend/File/Transfer/Exception.php';
        throw new Zend_File_Transfer_Exception('Method not implemented');
    }

addFilter()

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

Definition at line 750 of file Abstract.php.

    {
        if ($filter instanceof Zend_Filter_Interface) {
            $class = get_class($filter);
        } elseif (is_string($filter)) {
            $class  = $this->getPluginLoader(self::FILTER)->load($filter);
            $filter = new $class($options);
        } else {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('Invalid filter specified');
        }

        $this->_filters[$class] = $filter;
        $files                  = $this->_getFiles($files, true, true);
        foreach ($files as $file) {
            $this->_files[$file]['filters'][] = $class;
        }

        return $this;
    }

addFilters()

addFilters	(	array	$filters,
			$files = null
	)

Add Multiple filters at once

Parameters

array	$filters
string | array	$files

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 778 of file Abstract.php.

    {
        foreach ($filters as $key => $spec) {
            if ($spec instanceof Zend_Filter_Interface) {
                $this->addFilter($spec, null, $files);
                continue;
            }

            if (is_string($key)) {
                $this->addFilter($key, $spec, $files);
                continue;
            }

            if (is_int($key)) {
                if (is_string($spec)) {
                    $this->addFilter($spec, null, $files);
                    continue;
                }

                if (is_array($spec)) {
                    if (!array_key_exists('filter', $spec)) {
                        continue;
                    }

                    $filter = $spec['filter'];
                    unset($spec['filter']);
                    $this->addFilter($filter, $spec, $files);
                    continue;
                }

                continue;
            }
        }

        return $this;
    }

addPrefixPath()

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

Exceptions

Zend_File_Transfer_Exception

for invalid type

Definition at line 256 of file Abstract.php.

    {
        $type = strtoupper($type);
        switch ($type) {
            case self::FILTER:
            case self::VALIDATE:
                $loader = $this->getPluginLoader($type);
                $loader->addPrefixPath($prefix, $path);
                return $this;
            case null:
                $prefix = rtrim($prefix, '_');
                $path   = rtrim($path, DIRECTORY_SEPARATOR);
                foreach (array(self::FILTER, self::VALIDATE) as $type) {
                    $cType        = ucfirst(strtolower($type));
                    $pluginPath   = $path . DIRECTORY_SEPARATOR . $cType . DIRECTORY_SEPARATOR;
                    $pluginPrefix = $prefix . '_' . $cType;
                    $loader       = $this->getPluginLoader($type);
                    $loader->addPrefixPath($pluginPrefix, $pluginPath);
                }
                return $this;
            default:
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception(sprintf('Invalid type "%s" provided to getPluginLoader()', $type));
        }
    }

addPrefixPaths()

addPrefixPaths

(

array

$spec

)

Add many prefix paths at once

Parameters

array

$spec

Returns

Zend_File_Transfer_Exception

Definition at line 288 of file Abstract.php.

    {
        if (isset($spec['prefix']) && isset($spec['path'])) {
            return $this->addPrefixPath($spec['prefix'], $spec['path']);
        }
        foreach ($spec as $type => $paths) {
            if (is_numeric($type) && is_array($paths)) {
                $type = null;
                if (isset($paths['prefix']) && isset($paths['path'])) {
                    if (isset($paths['type'])) {
                        $type = $paths['type'];
                    }
                    $this->addPrefixPath($paths['prefix'], $paths['path'], $type);
                }
            } elseif (!is_numeric($type)) {
                if (!isset($paths['prefix']) || !isset($paths['path'])) {
                    foreach ($paths as $prefix => $spec) {
                        if (is_array($spec)) {
                            foreach ($spec as $path) {
                                if (!is_string($path)) {
                                    continue;
                                }
                                $this->addPrefixPath($prefix, $path, $type);
                            }
                        } elseif (is_string($spec)) {
                            $this->addPrefixPath($prefix, $spec, $type);
                        }
                    }
                } else {
                    $this->addPrefixPath($paths['prefix'], $paths['path'], $type);
                }
            }
        }
        return $this;
    }

addType()

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

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 1015 of file Abstract.php.

    {
        #require_once 'Zend/File/Transfer/Exception.php';
        throw new Zend_File_Transfer_Exception('Method not implemented');
    }

addValidator()

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

Definition at line 333 of file Abstract.php.

    {
        if ($validator instanceof Zend_Validate_Interface) {
            $name = get_class($validator);
        } elseif (is_string($validator)) {
            $name      = $this->getPluginLoader(self::VALIDATE)->load($validator);
            $validator = new $name($options);
            if (is_array($options) && isset($options['messages'])) {
                if (is_array($options['messages'])) {
                    $validator->setMessages($options['messages']);
                } elseif (is_string($options['messages'])) {
                    $validator->setMessage($options['messages']);
                }

                unset($options['messages']);
            }
        } else {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('Invalid validator provided to addValidator; must be string or Zend_Validate_Interface');
        }

        $this->_validators[$name] = $validator;
        $this->_break[$name]      = $breakChainOnFailure;
        $files                    = $this->_getFiles($files, true, true);
        foreach ($files as $file) {
            if ($name == 'NotEmpty') {
                $temp = $this->_files[$file]['validators'];
                $this->_files[$file]['validators']  = array($name);
                $this->_files[$file]['validators'] += $temp;
            } else {
                $this->_files[$file]['validators'][] = $name;
            }

            $this->_files[$file]['validated']    = false;
        }

        return $this;
    }

addValidators()

addValidators	(	array	$validators,
			$files = null
	)

Add Multiple validators at once

Parameters

array	$validators
string | array	$files

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 379 of file Abstract.php.

    {
        foreach ($validators as $name => $validatorInfo) {
            if ($validatorInfo instanceof Zend_Validate_Interface) {
                $this->addValidator($validatorInfo, null, null, $files);
            } else if (is_string($validatorInfo)) {
                if (!is_int($name)) {
                    $this->addValidator($name, null, $validatorInfo, $files);
                } else {
                    $this->addValidator($validatorInfo, null, null, $files);
                }
            } else if (is_array($validatorInfo)) {
                $argc                = count($validatorInfo);
                $breakChainOnFailure = false;
                $options             = array();
                if (isset($validatorInfo['validator'])) {
                    $validator = $validatorInfo['validator'];
                    if (isset($validatorInfo['breakChainOnFailure'])) {
                        $breakChainOnFailure = $validatorInfo['breakChainOnFailure'];
                    }

                    if (isset($validatorInfo['options'])) {
                        $options = $validatorInfo['options'];
                    }

                    $this->addValidator($validator, $breakChainOnFailure, $options, $files);
                } else {
                    if (is_string($name)) {
                        $validator = $name;
                        $options   = $validatorInfo;
                        $this->addValidator($validator, $breakChainOnFailure, $options, $files);
                    } else {
                        $file = $files;
                        switch (true) {
                            case (0 == $argc):
                                break;
                            case (1 <= $argc):
                                $validator  = array_shift($validatorInfo);
                            case (2 <= $argc):
                                $breakChainOnFailure = array_shift($validatorInfo);
                            case (3 <= $argc):
                                $options = array_shift($validatorInfo);
                            case (4 <= $argc):
                                if (!empty($validatorInfo)) {
                                    $file = array_shift($validatorInfo);
                                }
                            default:
                                $this->addValidator($validator, $breakChainOnFailure, $options, $file);
                                break;
                        }
                    }
                }
            } else {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception('Invalid validator passed to addValidators()');
            }
        }

        return $this;
    }

clearFilters()

clearFilters

(

)

Remove all filters

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 916 of file Abstract.php.

    {
        $this->_filters = array();
        foreach (array_keys($this->_files) as $file) {
            $this->_files[$file]['filters'] = array();
        }
        return $this;
    }

clearValidators()

clearValidators

(

)

Remove all validators

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 542 of file Abstract.php.

    {
        $this->_validators = array();
        foreach (array_keys($this->_files) as $file) {
            $this->_files[$file]['validators'] = array();
            $this->_files[$file]['validated']  = false;
        }

        return $this;
    }

getDestination()

getDestination

(

$files = null

)

Retrieve destination directory value

Parameters

null | string | array

$files

Returns

null|string|array

Exceptions

Zend_File_Transfer_Exception

Definition at line 1073 of file Abstract.php.

    {
        $orig  = $files;
        $files = $this->_getFiles($files, false, true);
        $destinations = array();
        if (empty($files) and is_string($orig)) {
            if (isset($this->_files[$orig]['destination'])) {
                $destinations[$orig] = $this->_files[$orig]['destination'];
            } else {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception(sprintf('The file transfer adapter can not find "%s"', $orig));
            }
        }

        foreach ($files as $key => $content) {
            if (isset($this->_files[$key]['destination'])) {
                $destinations[$key] = $this->_files[$key]['destination'];
            } else {
                $tmpdir = $this->_getTmpDir();
                $this->setDestination($tmpdir, $key);
                $destinations[$key] = $tmpdir;
            }
        }

        if (empty($destinations)) {
            $destinations = $this->_getTmpDir();
        } else if (count($destinations) == 1) {
            $destinations = current($destinations);
        }

        return $destinations;
    }

getErrors()

getErrors

(

)

Retrieve error codes

Returns

array

Definition at line 727 of file Abstract.php.

    {
        return array_keys($this->_messages);
    }

getFile()

getFile

(

)

Returns all set files

Returns

array List of set files

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 931 of file Abstract.php.

    {
        #require_once 'Zend/File/Transfer/Exception.php';
        throw new Zend_File_Transfer_Exception('Method not implemented');
    }

getFileInfo()

getFileInfo

(

$file = null

)

Retrieve additional internal file informations for files

Parameters

string

$file

(Optional) File to get informations for

Returns

array

Definition at line 974 of file Abstract.php.

    {
        return $this->_getFiles($file);
    }

getFileName()

getFileName	(		$file = null,
			$path = true
	)

Retrieves the filename of transferred files.

Parameters

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

Returns

string|array

Definition at line 944 of file Abstract.php.

    {
        $files     = $this->_getFiles($file, true, true);
        $result    = array();
        $directory = "";
        foreach($files as $file) {
            if (empty($this->_files[$file]['name'])) {
                continue;
            }

            if ($path === true) {
                $directory = $this->getDestination($file) . DIRECTORY_SEPARATOR;
            }

            $result[$file] = $directory . $this->_files[$file]['name'];
        }

        if (count($result) == 1) {
            return current($result);
        }

        return $result;
    }

getFileSize()

getFileSize

(

$files = null

)

Returns the real filesize of the file

Parameters

string | array

$files

Files to get the filesize from

Exceptions

Zend_File_Transfer_Exception

When the file does not exist

Returns

string|array Filesize

Definition at line 1207 of file Abstract.php.

    {
        $files  = $this->_getFiles($files);
        $result = array();
        foreach($files as $key => $value) {
            if (file_exists($value['name']) || file_exists($value['tmp_name'])) {
                if ($value['options']['useByteString']) {
                    $result[$key] = self::_toByteString($value['size']);
                } else {
                    $result[$key] = $value['size'];
                }
            } else if (empty($value['options']['ignoreNoFile'])) {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception("The file '{$value['name']}' does not exist");
            } else {
                continue;
            }
        }

        if (count($result) == 1) {
            return current($result);
        }

        return $result;
    }

getFilter()

getFilter

(

$name

)

Retrieve individual filter

Parameters

string

$name

Returns

Zend_Filter_Interface|null

Definition at line 845 of file Abstract.php.

    {
        if (false === ($identifier = $this->_getFilterIdentifier($name))) {
            return null;
        }
        return $this->_filters[$identifier];
    }

getFilters()

getFilters

(

$files = null

)

Returns all set filters

Parameters

string | array

$files

(Optional) Returns the filter for this files

Returns

array List of set filters

Exceptions

Zend_File_Transfer_Exception

When file not found

Definition at line 860 of file Abstract.php.

    {
        if ($files === null) {
            return $this->_filters;
        }

        $files   = $this->_getFiles($files, true, true);
        $filters = array();
        foreach ($files as $file) {
            if (!empty($this->_files[$file]['filters'])) {
                $filters += $this->_files[$file]['filters'];
            }
        }

        $filters = array_unique($filters);
        $result  = array();
        foreach ($filters as $filter) {
            $result[] = $this->_filters[$filter];
        }

        return $result;
    }

getHash()

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

Exceptions

Zend_File_Transfer_Exception

On unknown hash algorithm

Definition at line 1173 of file Abstract.php.

    {
        if (!in_array($hash, hash_algos())) {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('Unknown hash algorithm');
        }

        $files  = $this->_getFiles($files);
        $result = array();
        foreach($files as $key => $value) {
            if (file_exists($value['name'])) {
                $result[$key] = hash_file($hash, $value['name']);
            } else if (file_exists($value['tmp_name'])) {
                $result[$key] = hash_file($hash, $value['tmp_name']);
            } else if (empty($value['options']['ignoreNoFile'])) {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception("The file '{$value['name']}' does not exist");
            }
        }

        if (count($result) == 1) {
            return current($result);
        }

        return $result;
    }

getMessages()

getMessages

(

)

Returns found validation messages

Returns

array

Definition at line 717 of file Abstract.php.

    {
        return $this->_messages;
    }

getMimeType()

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

Exceptions

Zend_File_Transfer_Exception

When the file does not exist

Returns

string|array MimeType

Definition at line 1260 of file Abstract.php.

    {
        $files  = $this->_getFiles($files);
        $result = array();
        foreach($files as $key => $value) {
            if (file_exists($value['name']) || file_exists($value['tmp_name'])) {
                $result[$key] = $value['type'];
            } else if (empty($value['options']['ignoreNoFile'])) {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception("The file '{$value['name']}' does not exist");
            } else {
                continue;
            }
        }

        if (count($result) == 1) {
            return current($result);
        }

        return $result;
    }

getOptions()

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

Definition at line 598 of file Abstract.php.

                                              {
        $file = $this->_getFiles($files, false, true);

        foreach ($file as $key => $content) {
            if (isset($this->_files[$key]['options'])) {
                $options[$key] = $this->_files[$key]['options'];
            } else {
                $options[$key] = array();
            }
        }

        return $options;
    }

getPluginLoader()

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

Exceptions

Zend_File_Transfer_Exception

on invalid type.

Definition at line 210 of file Abstract.php.

    {
        $type = strtoupper($type);
        switch ($type) {
            case self::FILTER:
            case self::VALIDATE:
                $prefixSegment = ucfirst(strtolower($type));
                $pathSegment   = $prefixSegment;
                if (!isset($this->_loaders[$type])) {
                    $paths         = array(
                        'Zend_' . $prefixSegment . '_'     => 'Zend/' . $pathSegment . '/',
                        'Zend_' . $prefixSegment . '_File' => 'Zend/' . $pathSegment . '/File',
                    );

                    #require_once 'Zend/Loader/PluginLoader.php';
                    $this->_loaders[$type] = new Zend_Loader_PluginLoader($paths);
                } else {
                    $loader = $this->_loaders[$type];
                    $prefix = 'Zend_' . $prefixSegment . '_File_';
                    if (!$loader->getPaths($prefix)) {
                        $loader->addPrefixPath($prefix, str_replace('_', '/', $prefix));
                    }
                }
                return $this->_loaders[$type];
            default:
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception(sprintf('Invalid type "%s" provided to getPluginLoader()', $type));
        }
    }

getProgress()

static getProgress ( )

static

Retrieve progress of transfer

Returns

float

Definition at line 172 of file Abstract.php.

    {
        #require_once 'Zend/File/Transfer/Exception.php';
        throw new Zend_File_Transfer_Exception('Method must be implemented within the adapter');
    }

getTranslator()

getTranslator

(

)

Retrieve localization translator object

Returns

Zend_Translate_Adapter|null

Definition at line 1134 of file Abstract.php.

    {
        if ($this->translatorIsDisabled()) {
            return null;
        }

        return $this->_translator;
    }

getType()

getType

(

)

Returns all set types

Returns

array List of set types

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 1000 of file Abstract.php.

    {
        #require_once 'Zend/File/Transfer/Exception.php';
        throw new Zend_File_Transfer_Exception('Method not implemented');
    }

getValidator()

getValidator

(

$name

)

Retrieve individual validator

Parameters

string

$name

Returns

Zend_Validate_Interface|null

Definition at line 470 of file Abstract.php.

    {
        if (false === ($identifier = $this->_getValidatorIdentifier($name))) {
            return null;
        }
        return $this->_validators[$identifier];
    }

getValidators()

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

Definition at line 484 of file Abstract.php.

    {
        if ($files == null) {
            return $this->_validators;
        }

        $files      = $this->_getFiles($files, true, true);
        $validators = array();
        foreach ($files as $file) {
            if (!empty($this->_files[$file]['validators'])) {
                $validators += $this->_files[$file]['validators'];
            }
        }

        $validators = array_unique($validators);
        $result     = array();
        foreach ($validators as $validator) {
            $result[$validator] = $this->_validators[$validator];
        }

        return $result;
    }

hasErrors()

hasErrors

(

)

Are there errors registered?

Returns

boolean

Definition at line 737 of file Abstract.php.

    {
        return (!empty($this->_messages));
    }

hasFilter()

hasFilter

(

$name

)

Determine if a given filter has already been registered

Parameters

string

$name

Returns

bool

Definition at line 834 of file Abstract.php.

    {
        return (false !== $this->_getFilterIdentifier($name));
    }

hasValidator()

hasValidator

(

$name

)

Determine if a given validator has already been registered

Parameters

string

$name

Returns

bool

Definition at line 459 of file Abstract.php.

    {
        return (false !== $this->_getValidatorIdentifier($name));
    }

isFiltered()

isFiltered (   $files = null )

abstract

Has the file been filtered ?

Parameters

array | string | null

$files

Returns

bool

isReceived()

isReceived (   $files = null )

abstract

Is file received?

Parameters

array | string | null

$files

Returns

bool

isSent()

isSent (   $files = null )

abstract

Is file sent?

Parameters

array | string | null

$files

Returns

bool

isUploaded()

isUploaded (   $files = null )

abstract

Has a file been uploaded ?

Parameters

array | string | null

$files

Returns

bool

isValid()

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

Definition at line 618 of file Abstract.php.

    {
        $check = $this->_getFiles($files, false, true);
        if (empty($check)) {
            return false;
        }

        $translator      = $this->getTranslator();
        $this->_messages = array();
        $break           = false;
        foreach($check as $key => $content) {
            if (array_key_exists('validators', $content) &&
                in_array('Zend_Validate_File_Count', $content['validators'])) {
                $validator = $this->_validators['Zend_Validate_File_Count'];
                $count     = $content;
                if (empty($content['tmp_name'])) {
                    continue;
                }

                if (array_key_exists('destination', $content)) {
                    $checkit = $content['destination'];
                } else {
                    $checkit = dirname($content['tmp_name']);
                }

                $checkit .= DIRECTORY_SEPARATOR . $content['name'];
                    $validator->addFile($checkit);
            }
        }

        if (isset($count)) {
            if (!$validator->isValid($count['tmp_name'], $count)) {
                $this->_messages += $validator->getMessages();
            }
        }

        foreach ($check as $key => $content) {
            $fileerrors  = array();
            if (array_key_exists('validators', $content) && $content['validated']) {
                continue;
            }

            if (array_key_exists('validators', $content)) {
                foreach ($content['validators'] as $class) {
                    $validator = $this->_validators[$class];
                    if (method_exists($validator, 'setTranslator')) {
                        $validator->setTranslator($translator);
                    }

                    if (($class === 'Zend_Validate_File_Upload') and (empty($content['tmp_name']))) {
                        $tocheck = $key;
                    } else {
                        $tocheck = $content['tmp_name'];
                    }

                    if (!$validator->isValid($tocheck, $content)) {
                        $fileerrors += $validator->getMessages();
                    }

                    if (!empty($content['options']['ignoreNoFile']) and (isset($fileerrors['fileUploadErrorNoFile']))) {
                        unset($fileerrors['fileUploadErrorNoFile']);
                        break;
                    }

                    if (($class === 'Zend_Validate_File_Upload') and (count($fileerrors) > 0)) {
                        break;
                    }

                    if (($this->_break[$class]) and (count($fileerrors) > 0)) {
                        $break = true;
                        break;
                    }
                }
            }

            if (count($fileerrors) > 0) {
                $this->_files[$key]['validated'] = false;
            } else {
                $this->_files[$key]['validated'] = true;
            }

            $this->_messages += $fileerrors;
            if ($break) {
                break;
            }
        }

        if (count($this->_messages) > 0) {
            return false;
        }

        return true;
    }

receive()

receive (   $options = null )

abstract

Receive file

Parameters

mixed

$options

Returns

bool

removeFilter()

removeFilter

(

$name

)

Remove an individual filter

Parameters

string

$name

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 889 of file Abstract.php.

    {
        if (false === ($key = $this->_getFilterIdentifier($name))) {
            return $this;
        }

        unset($this->_filters[$key]);
        foreach (array_keys($this->_files) as $file) {
            if (empty($this->_files[$file]['filters'])) {
                continue;
            }

            $index = array_search($key, $this->_files[$file]['filters']);
            if ($index === false) {
                continue;
            }

            unset($this->_files[$file]['filters'][$index]);
        }
        return $this;
    }

removeValidator()

removeValidator

(

$name

)

Remove an individual validator

Parameters

string

$name

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 513 of file Abstract.php.

    {
        if (false === ($key = $this->_getValidatorIdentifier($name))) {
            return $this;
        }

        unset($this->_validators[$key]);
        foreach (array_keys($this->_files) as $file) {
            if (empty($this->_files[$file]['validators'])) {
                continue;
            }

            $index = array_search($key, $this->_files[$file]['validators']);
            if ($index === false) {
                continue;
            }

            unset($this->_files[$file]['validators'][$index]);
            $this->_files[$file]['validated'] = false;
        }

        return $this;
    }

send()

send (   $options = null )

abstract

Send file

Parameters

mixed

$options

Returns

bool

setDestination()

setDestination	(		$destination,
			$files = null
	)

Sets a new destination for the given files

Deprecated:

Will be changed to be a filter!!!

Parameters

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

Returns

Zend_File_Transfer_Abstract

Exceptions

Zend_File_Transfer_Exception

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

Definition at line 1030 of file Abstract.php.

    {
        $orig = $files;
        $destination = rtrim($destination, "/\\");
        if (!is_dir($destination)) {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception(
                'The given destination is not a directory or does not exist'
            );
        }

        if (!$this->_isPathWriteable($destination)) {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception(
                'The given destination is not writable'
            );
        }

        if ($files === null) {
            foreach ($this->_files as $file => $content) {
                $this->_files[$file]['destination'] = $destination;
            }
        } else {
            $files = $this->_getFiles($files, true, true);
            if (empty($files) and is_string($orig)) {
                $this->_files[$orig]['destination'] = $destination;
            }

            foreach ($files as $file) {
                $this->_files[$file]['destination'] = $destination;
            }
        }

        return $this;
    }

setDisableTranslator()

setDisableTranslator

(

$flag

)

Indicate whether or not translation should be disabled

Parameters

bool

$flag

Returns

Zend_File_Transfer_Abstract

Definition at line 1149 of file Abstract.php.

    {
        $this->_translatorDisabled = (bool) $flag;
        return $this;
    }

setFilters()

setFilters	(	array	$filters,
			$files = null
	)

Sets a filter for the class, erasing all previous set

Parameters

string | array	$filter	Filter to set
string | array	$files	Files to limit this filter to

Returns

Zend_File_Transfer_Adapter

Definition at line 822 of file Abstract.php.

    {
        $this->clearFilters();
        return $this->addFilters($filters, $files);
    }

setOptions()

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

Sets Options for adapters

Parameters

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

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 560 of file Abstract.php.

                                                                  {
        $file = $this->_getFiles($files, false, true);

        if (is_array($options)) {
            if (empty($file)) {
                $this->_options = array_merge($this->_options, $options);
            }

            foreach ($options as $name => $value) {
                foreach ($file as $key => $content) {
                    switch ($name) {
                        case 'magicFile' :
                            $this->_files[$key]['options'][$name] = (string) $value;
                            break;

                        case 'ignoreNoFile' :
                        case 'useByteString' :
                        case 'detectInfos' :
                            $this->_files[$key]['options'][$name] = (boolean) $value;
                            break;

                        default:
                            #require_once 'Zend/File/Transfer/Exception.php';
                            throw new Zend_File_Transfer_Exception("Unknown option: $name = $value");
                    }
                }
            }
        }

        return $this;
    }

setPluginLoader()

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

Exceptions

Zend_File_Transfer_Exception

on invalid type

Definition at line 186 of file Abstract.php.

    {
        $type = strtoupper($type);
        switch ($type) {
            case self::FILTER:
            case self::VALIDATE:
                $this->_loaders[$type] = $loader;
                return $this;
            default:
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception(sprintf('Invalid type "%s" provided to setPluginLoader()', $type));
        }
    }

setTranslator()

setTranslator

(

$translator = null

)

Set translator object for localization

Parameters

Zend_Translate | null

$translator

Returns

Zend_File_Transfer_Abstract

Exceptions

Zend_File_Transfer_Exception

Definition at line 1113 of file Abstract.php.

    {
        if (null === $translator) {
            $this->_translator = null;
        } elseif ($translator instanceof Zend_Translate_Adapter) {
            $this->_translator = $translator;
        } elseif ($translator instanceof Zend_Translate) {
            $this->_translator = $translator->getAdapter();
        } else {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('Invalid translator specified');
        }

        return $this;
    }

setValidators()

setValidators	(	array	$validators,
			$files = null
	)

Sets a validator for the class, erasing all previous set

Parameters

string | array	$validator	Validator to set
string | array	$files	Files to limit this validator to

Returns

Zend_File_Transfer_Adapter

Definition at line 447 of file Abstract.php.

    {
        $this->clearValidators();
        return $this->addValidators($validators, $files);
    }

translatorIsDisabled()

translatorIsDisabled

(

)

Is translation disabled?

Returns

bool

Definition at line 1160 of file Abstract.php.

    {
        return $this->_translatorDisabled;
    }

Field Documentation

$_break

$_break = array()

protected

Definition at line 44 of file Abstract.php.

$_files

$_files = array()

protected

Definition at line 101 of file Abstract.php.

$_filters

$_filters = array()

protected

Definition at line 51 of file Abstract.php.

$_loaders

$_loaders = array()

protected

Definition at line 58 of file Abstract.php.

$_messages

$_messages = array()

protected

Definition at line 65 of file Abstract.php.

$_options

$_options

protected

Initial value:

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

Available options for file transfers

Definition at line 112 of file Abstract.php.

$_tmpDir

$_tmpDir

protected

Definition at line 107 of file Abstract.php.

$_translator

$_translator

protected

Definition at line 70 of file Abstract.php.

$_translatorDisabled

$_translatorDisabled = false

protected

Definition at line 77 of file Abstract.php.

$_validators

$_validators = array()

protected

Definition at line 83 of file Abstract.php.

FILTER

const FILTER = 'FILTER'

+ Plugin loader Constants

Definition at line 35 of file Abstract.php.

VALIDATE

const VALIDATE = 'VALIDATE'

Definition at line 36 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/File/Transfer/Adapter/Abstract.php