Zend_Validate_File_FilesSize Class Reference

Inheritance diagram for Zend_Validate_File_FilesSize:

Public Member Functions
	__construct ($options)
	isValid ($value, $file=null)
Public Member Functions inherited from Zend_Validate_File_Size
	__construct ($options)
	setUseByteString ($byteString=true)
	useByteString ()
	getMin ($raw=false)
	setMin ($min)
	getMax ($raw=false)
	setMax ($max)
	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	TOO_BIG = 'fileFilesSizeTooBig'
const	TOO_SMALL = 'fileFilesSizeTooSmall'
const	NOT_READABLE = 'fileFilesSizeNotReadable'
Data Fields inherited from Zend_Validate_File_Size
const	TOO_BIG = 'fileSizeTooBig'
const	TOO_SMALL = 'fileSizeTooSmall'
const	NOT_FOUND = 'fileSizeNotFound'

Protected Attributes
	$_messageTemplates
	$_files
Protected Attributes inherited from Zend_Validate_File_Size
	$_messageTemplates
	$_messageVariables
	$_min
	$_max
	$_size
	$_useByteString = true
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)
Protected Member Functions inherited from Zend_Validate_File_Size
	_getSize ()
	_setSize ($size)
	_toByteString ($size)
	_fromByteString ($size)
	_throw ($file, $errorType)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file FilesSize.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

Min limits the used diskspace for all files, when used with max=null it is the maximum filesize It also accepts an array with the keys 'min' and 'max'

Parameters

integer | array | Zend_Config

$options

Options for this validator

Exceptions

Zend_Validate_Exception

Definition at line 69 of file FilesSize.php.

    {
        $this->_files = array();
        $this->_setSize(0);

        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_scalar($options)) {
            $options = array('max' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Invalid options to validator provided');
        }

        if (1 < func_num_args()) {
            $argv = func_get_args();
            array_shift($argv);
            $options['max'] = array_shift($argv);
            if (!empty($argv)) {
                $options['bytestring'] = array_shift($argv);
            }
        }

        parent::__construct($options);
    }

Member Function Documentation

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the disk usage of all files is at least min and not bigger than max (when max is not null).

Parameters

string | array	$value	Real file to check for size
array	$file	File data from Zend_File_Transfer

Returns

boolean

Definition at line 105 of file FilesSize.php.

    {
        #require_once 'Zend/Loader.php';
        if (is_string($value)) {
            $value = array($value);
        }

        $min  = $this->getMin(true);
        $max  = $this->getMax(true);
        $size = $this->_getSize();
        foreach ($value as $files) {
            // Is file readable ?
            if (!Zend_Loader::isReadable($files)) {
                $this->_throw($file, self::NOT_READABLE);
                continue;
            }

            if (!isset($this->_files[$files])) {
                $this->_files[$files] = $files;
            } else {
                // file already counted... do not count twice
                continue;
            }

            // limited to 2GB files
            $size += @filesize($files);
            $this->_size = $size;
            if (($max !== null) && ($max < $size)) {
                if ($this->useByteString()) {
                    $this->_max  = $this->_toByteString($max);
                    $this->_size = $this->_toByteString($size);
                    $this->_throw($file, self::TOO_BIG);
                    $this->_max  = $max;
                    $this->_size = $size;
                } else {
                    $this->_throw($file, self::TOO_BIG);
                }
            }
        }

        // Check that aggregate files are >= minimum size
        if (($min !== null) && ($size < $min)) {
            if ($this->useByteString()) {
                $this->_min  = $this->_toByteString($min);
                $this->_size = $this->_toByteString($size);
                $this->_throw($file, self::TOO_SMALL);
                $this->_min  = $min;
                $this->_size = $size;
            } else {
                $this->_throw($file, self::TOO_SMALL);
            }
        }

        return empty($this->_messages);
    }

Field Documentation

$_files

$_files

protected

Definition at line 58 of file FilesSize.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::TOO_BIG      => "All files in sum should have a maximum size of '%max%' but '%size%' were detected",
        self::TOO_SMALL    => "All files in sum should have a minimum size of '%min%' but '%size%' were detected",
        self::NOT_READABLE => "One or more files can not be read",
    )

Definition at line 47 of file FilesSize.php.

NOT_READABLE

const NOT_READABLE = 'fileFilesSizeNotReadable'

Definition at line 42 of file FilesSize.php.

TOO_BIG

const TOO_BIG = 'fileFilesSizeTooBig'

@const string Error constants

Definition at line 40 of file FilesSize.php.

TOO_SMALL

const TOO_SMALL = 'fileFilesSizeTooSmall'

Definition at line 41 of file FilesSize.php.

---

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

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