Zend_File_Transfer_Adapter_Http Class Reference

Inheritance diagram for Zend_File_Transfer_Adapter_Http:

Public Member Functions
	__construct ($options=array())
	setValidators (array $validators, $files=null)
	removeValidator ($name)
	clearValidators ()
	send ($options=null)
	isValid ($files=null)
	receive ($files=null)
	isSent ($files=null)
	isReceived ($files=null)
	isFiltered ($files=null)
	isUploaded ($files=null)
Public Member Functions inherited from Zend_File_Transfer_Adapter_Abstract
	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 ($id=null)
static	isApcAvailable ()
static	isUploadProgressAvailable ()
Static Public Member Functions inherited from Zend_File_Transfer_Adapter_Abstract
static	getProgress ()

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

Static Protected Attributes
static	$_callbackApc = 'apc_fetch'
static	$_callbackUploadProgress = 'uploadprogress_get_info'

Additional Inherited Members
Data Fields inherited from Zend_File_Transfer_Adapter_Abstract
const	FILTER = 'FILTER'
const	VALIDATE = 'VALIDATE'
Static Protected Member Functions inherited from Zend_File_Transfer_Adapter_Abstract
static	_toByteString ($size)
Protected Attributes inherited from Zend_File_Transfer_Adapter_Abstract
	$_break = array()
	$_filters = array()
	$_loaders = array()
	$_messages = array()
	$_translator
	$_translatorDisabled = false
	$_validators = array()
	$_files = array()
	$_tmpDir
	$_options

Detailed Description

Definition at line 35 of file Http.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Constructor for Http File Transfers

Parameters

array

$options

OPTIONAL Options to set

Definition at line 45 of file Http.php.

    {
        if (ini_get('file_uploads') == false) {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('File uploads are not allowed in your php config!');
        }

        $this->setOptions($options);
        $this->_prepareFiles();
        $this->addValidator('Upload', false, $this->_files);
    }

Member Function Documentation

_prepareFiles()

_prepareFiles ( )

protected

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

Parameters

array

$files

Returns

array

Definition at line 435 of file Http.php.

    {
        $this->_files = array();
        foreach ($_FILES as $form => $content) {
            if (is_array($content['name'])) {
                foreach ($content as $param => $file) {
                    foreach ($file as $number => $target) {
                        $this->_files[$form . '_' . $number . '_'][$param]      = $target;
                        $this->_files[$form]['multifiles'][$number] = $form . '_' . $number . '_';
                    }
                }

                $this->_files[$form]['name'] = $form;
                foreach($this->_files[$form]['multifiles'] as $key => $value) {
                    $this->_files[$value]['options']   = $this->_options;
                    $this->_files[$value]['validated'] = false;
                    $this->_files[$value]['received']  = false;
                    $this->_files[$value]['filtered']  = false;

                    $mimetype = $this->_detectMimeType($this->_files[$value]);
                    $this->_files[$value]['type'] = $mimetype;

                    $filesize = $this->_detectFileSize($this->_files[$value]);
                    $this->_files[$value]['size'] = $filesize;

                    if ($this->_options['detectInfos']) {
                        $_FILES[$form]['type'][$key] = $mimetype;
                        $_FILES[$form]['size'][$key] = $filesize;
                    }
                }
            } else {
                $this->_files[$form]              = $content;
                $this->_files[$form]['options']   = $this->_options;
                $this->_files[$form]['validated'] = false;
                $this->_files[$form]['received']  = false;
                $this->_files[$form]['filtered']  = false;

                $mimetype = $this->_detectMimeType($this->_files[$form]);
                $this->_files[$form]['type'] = $mimetype;

                $filesize = $this->_detectFileSize($this->_files[$form]);
                $this->_files[$form]['size'] = $filesize;

                if ($this->_options['detectInfos']) {
                    $_FILES[$form]['type'] = $mimetype;
                    $_FILES[$form]['size'] = $filesize;
                }
            }
        }

        return $this;
    }

clearValidators()

clearValidators

(

)

Remove an individual validator

Parameters

string

$name

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 91 of file Http.php.

    {
        parent::clearValidators();
        $this->addValidator('Upload', false, $this->_files);

        return $this;
    }

getProgress()

static getProgress (   $id = null )

static

Returns the actual progress of file up-/downloads

Parameters

string

$id

The upload to get the progress for

Returns

array|null

Definition at line 307 of file Http.php.

    {
        if (!function_exists('apc_fetch') and !function_exists('uploadprogress_get_info')) {
            #require_once 'Zend/File/Transfer/Exception.php';
            throw new Zend_File_Transfer_Exception('Neither APC nor uploadprogress extension installed');
        }

        $session = 'Zend_File_Transfer_Adapter_Http_ProgressBar';
        $status  = array(
            'total'    => 0,
            'current'  => 0,
            'rate'     => 0,
            'message'  => '',
            'done'     => false
        );

        if (is_array($id)) {
            if (isset($id['progress'])) {
                $adapter = $id['progress'];
            }

            if (isset($id['session'])) {
                $session = $id['session'];
            }

            if (isset($id['id'])) {
                $id = $id['id'];
            } else {
                unset($id);
            }
        }

        if (!empty($id) && (($id instanceof Zend_ProgressBar_Adapter) || ($id instanceof Zend_ProgressBar))) {
            $adapter = $id;
            unset($id);
        }

        if (empty($id)) {
            if (!isset($_GET['progress_key'])) {
                $status['message'] = 'No upload in progress';
                $status['done']    = true;
            } else {
                $id = $_GET['progress_key'];
            }
        }

        if (!empty($id)) {
            if (self::isApcAvailable()) {

                $call = call_user_func(self::$_callbackApc, ini_get('apc.rfc1867_prefix') . $id);
                if (is_array($call)) {
                    $status = $call + $status;
                }
            } else if (self::isUploadProgressAvailable()) {
                $call = call_user_func(self::$_callbackUploadProgress, $id);
                if (is_array($call)) {
                    $status = $call + $status;
                    $status['total']   = $status['bytes_total'];
                    $status['current'] = $status['bytes_uploaded'];
                    $status['rate']    = $status['speed_average'];
                    if ($status['total'] == $status['current']) {
                        $status['done'] = true;
                    }
                }
            }

            if (!is_array($call)) {
                $status['done']    = true;
                $status['message'] = 'Failure while retrieving the upload progress';
            } else if (!empty($status['cancel_upload'])) {
                $status['done']    = true;
                $status['message'] = 'The upload has been canceled';
            } else {
                $status['message'] = self::_toByteString($status['current']) . " - " . self::_toByteString($status['total']);
            }

            $status['id'] = $id;
        }

        if (isset($adapter) && isset($status['id'])) {
            if ($adapter instanceof Zend_ProgressBar_Adapter) {
                #require_once 'Zend/ProgressBar.php';
                $adapter = new Zend_ProgressBar($adapter, 0, $status['total'], $session);
            }

            if (!($adapter instanceof Zend_ProgressBar)) {
                #require_once 'Zend/File/Transfer/Exception.php';
                throw new Zend_File_Transfer_Exception('Unknown Adapter given');
            }

            if ($status['done']) {
                $adapter->finish();
            } else {
                $adapter->update($status['current'], $status['message']);
            }

            $status['progress'] = $adapter;
        }

        return $status;
    }

isApcAvailable()

static isApcAvailable ( )

static

Checks the APC extension for progress information

Returns

boolean

Definition at line 414 of file Http.php.

    {
        return (bool) ini_get('apc.enabled') && (bool) ini_get('apc.rfc1867') && is_callable(self::$_callbackApc);
    }

isFiltered()

isFiltered

(

$files = null

)

Checks if the file was already filtered

Parameters

string | array

$files

(Optional) Files to check

Returns

bool

Definition at line 263 of file Http.php.

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

        foreach ($files as $content) {
            if ($content['filtered'] !== true) {
                return false;
            }
        }

        return true;
    }

isReceived()

isReceived

(

$files = null

)

Checks if the file was already received

Parameters

string | array

$files

(Optional) Files to check

Returns

bool

Definition at line 241 of file Http.php.

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

        foreach ($files as $content) {
            if ($content['received'] !== true) {
                return false;
            }
        }

        return true;
    }

isSent()

isSent

(

$files = null

)

Checks if the file was already sent

Parameters

string | array

$file

Files to check

Returns

bool

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 229 of file Http.php.

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

isUploaded()

isUploaded

(

$files = null

)

Has a file been uploaded ?

Parameters

array | string | null

$file

Returns

bool

Definition at line 285 of file Http.php.

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

        foreach ($files as $file) {
            if (empty($file['name'])) {
                return false;
            }
        }

        return true;
    }

isUploadProgressAvailable()

static isUploadProgressAvailable ( )

static

Checks the UploadProgress extension for progress information

Returns

boolean

Definition at line 424 of file Http.php.

    {
        return is_callable(self::$_callbackUploadProgress);
    }

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 118 of file Http.php.

    {
        // Workaround for WebServer not conforming HTTP and omitting CONTENT_LENGTH
        $content = 0;
        if (isset($_SERVER['CONTENT_LENGTH'])) {
            $content = $_SERVER['CONTENT_LENGTH'];
        } else if (!empty($_POST)) {
            $content = serialize($_POST);
        }

        // Workaround for a PHP error returning empty $_FILES when form data exceeds php settings
        if (empty($this->_files) && ($content > 0)) {
            if (is_array($files)) {
                if (0 === count($files)) {
                    return false;
                }

                $files = current($files);
            }

            $temp = array($files => array(
                'name'  => $files,
                'error' => 1));
            $validator = $this->_validators['Zend_Validate_File_Upload'];
            $validator->setFiles($temp)
                      ->isValid($files, null);
            $this->_messages += $validator->getMessages();
            return false;
        }

        return parent::isValid($files);
    }

receive()

receive

(

$files = null

)

Receive the file from the client (Upload)

Parameters

string | array

$files

(Optional) Files to receive

Returns

bool

Definition at line 157 of file Http.php.

    {
        if (!$this->isValid($files)) {
            return false;
        }

        $check = $this->_getFiles($files);
        foreach ($check as $file => $content) {
            if (!$content['received']) {
                $directory   = '';
                $destination = $this->getDestination($file);
                if ($destination !== null) {
                    $directory = $destination . DIRECTORY_SEPARATOR;
                }

                $filename = $directory . $content['name'];
                $rename   = $this->getFilter('Rename');
                if ($rename !== null) {
                    $tmp = $rename->getNewName($content['tmp_name']);
                    if ($tmp != $content['tmp_name']) {
                        $filename = $tmp;
                    }

                    if (dirname($filename) == '.') {
                        $filename = $directory . $filename;
                    }

                    $key = array_search(get_class($rename), $this->_files[$file]['filters']);
                    unset($this->_files[$file]['filters'][$key]);
                }

                // Should never return false when it's tested by the upload validator
                if (!move_uploaded_file($content['tmp_name'], $filename)) {
                    if ($content['options']['ignoreNoFile']) {
                        $this->_files[$file]['received'] = true;
                        $this->_files[$file]['filtered'] = true;
                        continue;
                    }

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

                if ($rename !== null) {
                    $this->_files[$file]['destination'] = dirname($filename);
                    $this->_files[$file]['name']        = basename($filename);
                }

                $this->_files[$file]['tmp_name'] = $filename;
                $this->_files[$file]['received'] = true;
            }

            if (!$content['filtered']) {
                if (!$this->_filter($file)) {
                    $this->_files[$file]['filtered'] = false;
                    return false;
                }

                $this->_files[$file]['filtered'] = true;
            }
        }

        return true;
    }

removeValidator()

removeValidator

(

$name

)

Remove an individual validator

Parameters

string

$name

Returns

Zend_File_Transfer_Adapter_Abstract

Definition at line 76 of file Http.php.

    {
        if ($name == 'Upload') {
            return $this;
        }

        return parent::removeValidator($name);
    }

send()

send

(

$options = null

)

Send the file to the client (Download)

Parameters

string | array

$options

Options for the file(s) to send

Returns

void

Exceptions

Zend_File_Transfer_Exception

Not implemented

Definition at line 106 of file Http.php.

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

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 64 of file Http.php.

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

Field Documentation

$_callbackApc

$_callbackApc = 'apc_fetch'

staticprotected

Definition at line 37 of file Http.php.

$_callbackUploadProgress

$_callbackUploadProgress = 'uploadprogress_get_info'

staticprotected

Definition at line 38 of file Http.php.

---

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

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