Zend_Validate_File_Size Class Reference

Inheritance diagram for Zend_Validate_File_Size:

Public Member Functions
	__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 = 'fileSizeTooBig'
const	TOO_SMALL = 'fileSizeTooSmall'
const	NOT_FOUND = 'fileSizeNotFound'

Protected Member Functions
	_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)

Protected Attributes
	$_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)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file Size.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

If $options is a integer, it will be used as maximum filesize As Array is accepts the following keys: 'min': Minimum filesize 'max': Maximum filesize 'bytestring': Use bytestring or real size for messages

Parameters

integer | array

$options

Options for the adapter

Exceptions

Zend_Validate_Exception

Definition at line 104 of file Size.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_string($options) || is_numeric($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);
            }
        }

        if (isset($options['bytestring'])) {
            $this->setUseByteString($options['bytestring']);
        }

        if (isset($options['min'])) {
            $this->setMin($options['min']);
        }

        if (isset($options['max'])) {
            $this->setMax($options['max']);
        }
    }

Member Function Documentation

_fromByteString()

_fromByteString (   $size )

protected

Returns the unformatted size

Parameters

string

$size

Returns

integer

Definition at line 340 of file Size.php.

    {
        if (is_numeric($size)) {
            return (integer) $size;
        }

        $type  = trim(substr($size, -2, 1));

        $value = substr($size, 0, -1);
        if (!is_numeric($value)) {
            $value = substr($value, 0, -1);
        }

        switch (strtoupper($type)) {
            case 'Y':
                $value *= (1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024);
                break;
            case 'Z':
                $value *= (1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024);
                break;
            case 'E':
                $value *= (1024 * 1024 * 1024 * 1024 * 1024 * 1024);
                break;
            case 'P':
                $value *= (1024 * 1024 * 1024 * 1024 * 1024);
                break;
            case 'T':
                $value *= (1024 * 1024 * 1024 * 1024);
                break;
            case 'G':
                $value *= (1024 * 1024 * 1024);
                break;
            case 'M':
                $value *= (1024 * 1024);
                break;
            case 'K':
                $value *= 1024;
                break;
            default:
                break;
        }

        return $value;
    }

_getSize()

_getSize ( )

protected

Retrieve current detected file size

Returns

int

Definition at line 248 of file Size.php.

    {
        return $this->_size;
    }

_setSize()

_setSize (   $size )

protected

Set current size

Parameters

int

$size

Returns

Zend_Validate_File_Size

Definition at line 259 of file Size.php.

    {
        $this->_size = $size;
        return $this;
    }

_throw()

_throw (   $file,   $errorType  )

protected

Throws an error of the given type

Parameters

string	$file
string	$errorType

Returns

false

Definition at line 392 of file Size.php.

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

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

_toByteString()

_toByteString (   $size )

protected

Returns the formatted size

Parameters

integer

$size

Returns

string

Definition at line 324 of file Size.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];
    }

getMax()

getMax

(

$raw = false

)

Returns the maximum filesize

Parameters

bool

$raw

Whether or not to force return of the raw value (defaults off)

Returns

integer|string

Definition at line 207 of file Size.php.

    {
        $max = $this->_max;
        if (!$raw && $this->useByteString()) {
            $max = $this->_toByteString($max);
        }

        return $max;
    }

getMin()

getMin

(

$raw = false

)

Returns the minimum filesize

Parameters

bool

$raw

Whether or not to force return of the raw value (defaults off)

Returns

integer|string

Definition at line 165 of file Size.php.

    {
        $min = $this->_min;
        if (!$raw && $this->useByteString()) {
            $min = $this->_toByteString($min);
        }

        return $min;
    }

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the filesize of $value is at least min and not bigger than max (when max is not null).

Parameters

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

Returns

boolean

Definition at line 275 of file Size.php.

    {
        // Is file readable ?
        #require_once 'Zend/Loader.php';
        if (!Zend_Loader::isReadable($value)) {
            return $this->_throw($file, self::NOT_FOUND);
        }

        // limited to 4GB files
        $size        = sprintf("%u", @filesize($value));
        $this->_size = $size;

        // Check to see if it's smaller than min size
        $min = $this->getMin(true);
        $max = $this->getMax(true);
        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);
            }
        }

        // Check to see if it's larger than max 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);
            }
        }

        return empty($this->_messages);
    }

setMax()

setMax

(

$max

)

Sets the maximum filesize

Parameters

integer

$max

The maximum filesize

Exceptions

Zend_Validate_Exception

When max is smaller than min

Returns

Zend_Validate_StringLength Provides a fluent interface

Definition at line 224 of file Size.php.

    {
        if (!is_string($max) && !is_numeric($max)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        $max = (integer) $this->_fromByteString($max);
        $min = $this->getMin(true);
        if (($min !== null) && ($max < $min)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The maximum must be greater than or equal to the minimum filesize, but "
                                            . "$max < $min");
        }

        $this->_max = $max;
        return $this;
    }

setMin()

setMin

(

$min

)

Sets the minimum filesize

Parameters

integer

$min

The minimum filesize

Exceptions

Zend_Validate_Exception

When min is greater than max

Returns

Zend_Validate_File_Size Provides a fluent interface

Definition at line 182 of file Size.php.

    {
        if (!is_string($min) and !is_numeric($min)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        $min = (integer) $this->_fromByteString($min);
        $max = $this->getMax(true);
        if (($max !== null) && ($min > $max)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The minimum must be less than or equal to the maximum filesize, but $min >"
                                            . " $max");
        }

        $this->_min = $min;
        return $this;
    }

setUseByteString()

setUseByteString

(

$byteString = true

)

Returns the minimum filesize

Parameters

boolean

$byteString

Use bytestring ?

Returns

integer

Definition at line 143 of file Size.php.

    {
        $this->_useByteString = (bool) $byteString;
        return $this;
    }

useByteString()

useByteString

(

)

Will bytestring be used?

Returns

boolean

Definition at line 154 of file Size.php.

    {
        return $this->_useByteString;
    }

Field Documentation

$_max

$_max

protected

Definition at line 76 of file Size.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::TOO_BIG   => "Maximum allowed size for file '%value%' is '%max%' but '%size%' detected",
        self::TOO_SMALL => "Minimum expected size for file '%value%' is '%min%' but '%size%' detected",
        self::NOT_FOUND => "File '%value%' is not readable or does not exist",
    )

Definition at line 48 of file Size.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'min'  => '_min',
        'max'  => '_max',
        'size' => '_size',
    )

Definition at line 57 of file Size.php.

$_min

$_min

protected

Definition at line 67 of file Size.php.

$_size

$_size

protected

Definition at line 83 of file Size.php.

$_useByteString

$_useByteString = true

protected

Definition at line 90 of file Size.php.

NOT_FOUND

const NOT_FOUND = 'fileSizeNotFound'

Definition at line 42 of file Size.php.

TOO_BIG

const TOO_BIG = 'fileSizeTooBig'

#+ @const string Error constants

Definition at line 40 of file Size.php.

TOO_SMALL

const TOO_SMALL = 'fileSizeTooSmall'

Definition at line 41 of file Size.php.

---

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

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