Zend_Validate_File_Upload Class Reference

Inheritance diagram for Zend_Validate_File_Upload:

Public Member Functions
	__construct ($files=array())
	getFiles ($file=null)
	setFiles ($files=array())
	isValid ($value, $file=null)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)

Data Fields
const	INI_SIZE = 'fileUploadErrorIniSize'
const	FORM_SIZE = 'fileUploadErrorFormSize'
const	PARTIAL = 'fileUploadErrorPartial'
const	NO_FILE = 'fileUploadErrorNoFile'
const	NO_TMP_DIR = 'fileUploadErrorNoTmpDir'
const	CANT_WRITE = 'fileUploadErrorCantWrite'
const	EXTENSION = 'fileUploadErrorExtension'
const	ATTACK = 'fileUploadErrorAttack'
const	FILE_NOT_FOUND = 'fileUploadErrorFileNotFound'
const	UNKNOWN = 'fileUploadErrorUnknown'

Protected Member Functions
	_throw ($file, $errorType)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

Protected Attributes
	$_messageTemplates
	$_files = array()
Protected Attributes inherited from Zend_Validate_Abstract
	$_value
	$_messageVariables = array()
	$_messageTemplates = array()
	$_messages = array()
	$_obscureValue = false
	$_errors = array()
	$_translator
	$_translatorDisabled = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Validate_Abstract
static	setDefaultTranslator ($translator=null)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file Upload.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$files = array()

)

Sets validator options

The array $files must be given in syntax of Zend_File_Transfer to be checked If no files are given the $_FILES array will be used automatically. NOTE: This validator will only work with HTTP POST uploads!

Parameters

array | Zend_Config

$files

Array of files in syntax of Zend_File_Transfer

Definition at line 83 of file Upload.php.

    {
        if ($files instanceof Zend_Config) {
            $files = $files->toArray();
        }

        $this->setFiles($files);
    }

Member Function Documentation

_throw()

_throw (   $file,   $errorType  )

protected

Throws an error of the given type

Parameters

string	$file
string	$errorType

Returns

false

Definition at line 236 of file Upload.php.

    {
        if ($file !== null) {
            if (is_array($file) and !empty($file['name'])) {
                $this->_value = $file['name'];
            }
        }

        $this->_error($errorType);
        return false;
    }

getFiles()

getFiles

(

$file = null

)

Returns the array of set files

Parameters

string

$file

(Optional) The file to return in detail

Returns

array

Exceptions

Zend_Validate_Exception

If file is not found

Definition at line 99 of file Upload.php.

    {
        if ($file !== null) {
            $return = array();
            foreach ($this->_files as $name => $content) {
                if ($name === $file) {
                    $return[$file] = $this->_files[$name];
                }

                if ($content['name'] === $file) {
                    $return[$name] = $this->_files[$name];
                }
            }

            if (count($return) === 0) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("The file '$file' was not found");
            }

            return $return;
        }

        return $this->_files;
    }

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the file was uploaded without errors

Parameters

string	$value	Single file to check for upload errors, when giving null the $_FILES array from initialization will be used
string | null	$file

Returns

boolean

Definition at line 162 of file Upload.php.

    {
        $this->_messages = [];
        if (array_key_exists($value, $this->_files)) {
            $files[$value] = $this->_files[$value];
        } else {
            foreach ($this->_files as $file => $content) {
                if (isset($content['name']) && ($content['name'] === $value)) {
                    $files[$file] = $this->_files[$file];
                }

                if (isset($content['tmp_name']) && ($content['tmp_name'] === $value)) {
                    $files[$file] = $this->_files[$file];
                }
            }
        }

        if (empty($files)) {
            return $this->_throw($file, self::FILE_NOT_FOUND);
        }

        foreach ($files as $file => $content) {
            $this->_value = $file;
            switch($content['error']) {
                case 0:
                    if (!is_uploaded_file($content['tmp_name'])) {
                        $this->_throw($content, self::ATTACK);
                    }
                    break;

                case 1:
                    $this->_throw($content, self::INI_SIZE);
                    break;

                case 2:
                    $this->_throw($content, self::FORM_SIZE);
                    break;

                case 3:
                    $this->_throw($content, self::PARTIAL);
                    break;

                case 4:
                    $this->_throw($content, self::NO_FILE);
                    break;

                case 6:
                    $this->_throw($content, self::NO_TMP_DIR);
                    break;

                case 7:
                    $this->_throw($content, self::CANT_WRITE);
                    break;

                case 8:
                    $this->_throw($content, self::EXTENSION);
                    break;

                default:
                    $this->_throw($content, self::UNKNOWN);
                    break;
            }
        }

        return empty($this->_messages);
    }

setFiles()

setFiles

(

$files = array()

)

Sets the files to be checked

Parameters

array

$files

The files to check in syntax of Zend_File_Transfer

Returns

Zend_Validate_File_Upload Provides a fluent interface

Definition at line 130 of file Upload.php.

    {
        if (count($files) === 0) {
            $this->_files = $_FILES;
        } else {
            $this->_files = $files;
        }

        // see ZF-10738
        if (is_null($this->_files)) {
            $this->_files = array();
        }

        foreach($this->_files as $file => $content) {
            if (!isset($content['error'])) {
                unset($this->_files[$file]);
            }
        }

        return $this;
    }

Field Documentation

$_files

$_files = array()

protected

Definition at line 72 of file Upload.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::INI_SIZE       => "File '%value%' exceeds the defined ini size",
        self::FORM_SIZE      => "File '%value%' exceeds the defined form size",
        self::PARTIAL        => "File '%value%' was only partially uploaded",
        self::NO_FILE        => "File '%value%' was not uploaded",
        self::NO_TMP_DIR     => "No temporary directory was found for file '%value%'",
        self::CANT_WRITE     => "File '%value%' can't be written",
        self::EXTENSION      => "A PHP extension returned an error while uploading the file '%value%'",
        self::ATTACK         => "File '%value%' was illegally uploaded. This could be a possible attack",
        self::FILE_NOT_FOUND => "File '%value%' was not found",
        self::UNKNOWN        => "Unknown error while uploading file '%value%'"
    )

Definition at line 55 of file Upload.php.

ATTACK

const ATTACK = 'fileUploadErrorAttack'

Definition at line 47 of file Upload.php.

CANT_WRITE

const CANT_WRITE = 'fileUploadErrorCantWrite'

Definition at line 45 of file Upload.php.

EXTENSION

const EXTENSION = 'fileUploadErrorExtension'

Definition at line 46 of file Upload.php.

FILE_NOT_FOUND

const FILE_NOT_FOUND = 'fileUploadErrorFileNotFound'

Definition at line 48 of file Upload.php.

FORM_SIZE

const FORM_SIZE = 'fileUploadErrorFormSize'

Definition at line 41 of file Upload.php.

INI_SIZE

const INI_SIZE = 'fileUploadErrorIniSize'

#+ @const string Error constants

Definition at line 40 of file Upload.php.

NO_FILE

const NO_FILE = 'fileUploadErrorNoFile'

Definition at line 43 of file Upload.php.

NO_TMP_DIR

const NO_TMP_DIR = 'fileUploadErrorNoTmpDir'

Definition at line 44 of file Upload.php.

PARTIAL

const PARTIAL = 'fileUploadErrorPartial'

Definition at line 42 of file Upload.php.

UNKNOWN

const UNKNOWN = 'fileUploadErrorUnknown'

Definition at line 49 of file Upload.php.

---

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

• vendor/magento/zendframework1/library/Zend/Validate/File/Upload.php