Zend_Validate_File_ImageSize Class Reference

Inheritance diagram for Zend_Validate_File_ImageSize:

Public Member Functions
	__construct ($options)
	getImageMin ()
	getImageMax ()
	getImageWidth ()
	getImageHeight ()
	setImageMin ($options)
	setImageMax ($options)
	setImageWidth ($options)
	setImageHeight ($options)
	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	WIDTH_TOO_BIG = 'fileImageSizeWidthTooBig'
const	WIDTH_TOO_SMALL = 'fileImageSizeWidthTooSmall'
const	HEIGHT_TOO_BIG = 'fileImageSizeHeightTooBig'
const	HEIGHT_TOO_SMALL = 'fileImageSizeHeightTooSmall'
const	NOT_DETECTED = 'fileImageSizeNotDetected'
const	NOT_READABLE = 'fileImageSizeNotReadable'

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
	$_messageVariables
	$_minwidth
	$_maxwidth
	$_minheight
	$_maxheight
	$_width
	$_height
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 ImageSize.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

Accepts the following option keys:

• minheight
• minwidth
• maxheight
• maxwidth

Parameters

Zend_Config | array

$options

Exceptions

Zend_Validate_Exception

Definition at line 125 of file ImageSize.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (1 < func_num_args()) {
            if (!is_array($options)) {
                $options = array('minwidth' => $options);
            }
            $argv = func_get_args();
            array_shift($argv);
            $options['minheight'] = array_shift($argv);
            if (!empty($argv)) {
                $options['maxwidth'] = array_shift($argv);
                if (!empty($argv)) {
                    $options['maxheight'] = array_shift($argv);
                }
            }
        } else if (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        if (isset($options['minheight']) || isset($options['minwidth'])) {
            $this->setImageMin($options);
        }

        if (isset($options['maxheight']) || isset($options['maxwidth'])) {
            $this->setImageMax($options);
        }
    }

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 351 of file ImageSize.php.

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

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

getImageHeight()

getImageHeight

(

)

Returns the set image height sizes

Returns

array

Definition at line 191 of file ImageSize.php.

    {
        return array('minheight' => $this->_minheight, 'maxheight' => $this->_maxheight);
    }

getImageMax()

getImageMax

(

)

Returns the set maximum image sizes

Returns

array

Definition at line 171 of file ImageSize.php.

    {
        return array('maxwidth' => $this->_maxwidth, 'maxheight' => $this->_maxheight);
    }

getImageMin()

getImageMin

(

)

Returns the set minimum image sizes

Returns

array

Definition at line 161 of file ImageSize.php.

    {
        return array('minwidth' => $this->_minwidth, 'minheight' => $this->_minheight);
    }

getImageWidth()

getImageWidth

(

)

Returns the set image width sizes

Returns

array

Definition at line 181 of file ImageSize.php.

    {
        return array('minwidth' => $this->_minwidth, 'maxwidth' => $this->_maxwidth);
    }

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the imagesize of $value is at least min and not bigger than max

Parameters

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

Returns

boolean

Definition at line 308 of file ImageSize.php.

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

        $size = @getimagesize($value);
        $this->_setValue($file);

        if (empty($size) or ($size[0] === 0) or ($size[1] === 0)) {
            return $this->_throw($file, self::NOT_DETECTED);
        }

        $this->_width  = $size[0];
        $this->_height = $size[1];
        if ($this->_width < $this->_minwidth) {
            $this->_throw($file, self::WIDTH_TOO_SMALL);
        }

        if (($this->_maxwidth !== null) and ($this->_maxwidth < $this->_width)) {
            $this->_throw($file, self::WIDTH_TOO_BIG);
        }

        if ($this->_height < $this->_minheight) {
            $this->_throw($file, self::HEIGHT_TOO_SMALL);
        }

        if (($this->_maxheight !== null) and ($this->_maxheight < $this->_height)) {
            $this->_throw($file, self::HEIGHT_TOO_BIG);
        }

        return empty($this->_messages);
    }

setImageHeight()

setImageHeight

(

$options

)

Sets the mimimum and maximum image height

Parameters

array

$options

The image height dimensions

Returns

Zend_Validate_File_ImageSize Provides a fluent interface

Definition at line 290 of file ImageSize.php.

    {
        $this->setImageMin($options);
        $this->setImageMax($options);

        return $this;
    }

setImageMax()

setImageMax

(

$options

)

Sets the maximum image size

Parameters

array

$options

The maximum image dimensions

Exceptions

Zend_Validate_Exception	When maxwidth is smaller than minwidth
Zend_Validate_Exception	When maxheight is smaller than minheight

Returns

Zend_Validate_StringLength Provides a fluent interface

Definition at line 241 of file ImageSize.php.

    {
        if (isset($options['maxwidth'])) {
            if (($this->_minwidth !== null) and ($options['maxwidth'] < $this->_minwidth)) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("The maximum image width must be greater than or equal to the "
                    . "minimum image width, but {$options['maxwidth']} < {$this->_minwidth}");
            }
        }

        if (isset($options['maxheight'])) {
            if (($this->_minheight !== null) and ($options['maxheight'] < $this->_minheight)) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("The maximum image height must be greater than or equal to the "
                    . "minimum image height, but {$options['maxheight']} < {$this->_minwidth}");
            }
        }

        if (isset($options['maxwidth'])) {
            $this->_maxwidth  = (int) $options['maxwidth'];
        }

        if (isset($options['maxheight'])) {
            $this->_maxheight = (int) $options['maxheight'];
        }

        return $this;
    }

setImageMin()

setImageMin

(

$options

)

Sets the minimum image size

Parameters

array

$options

The minimum image dimensions

Exceptions

Zend_Validate_Exception	When minwidth is greater than maxwidth
Zend_Validate_Exception	When minheight is greater than maxheight

Returns

Zend_Validate_File_ImageSize Provides a fluent interface

Definition at line 204 of file ImageSize.php.

    {
        if (isset($options['minwidth'])) {
            if (($this->_maxwidth !== null) and ($options['minwidth'] > $this->_maxwidth)) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("The minimum image width must be less than or equal to the "
                    . " maximum image width, but {$options['minwidth']} > {$this->_maxwidth}");
            }
        }

        if (isset($options['maxheight'])) {
            if (($this->_maxheight !== null) and ($options['minheight'] > $this->_maxheight)) {
                #require_once 'Zend/Validate/Exception.php';
                throw new Zend_Validate_Exception("The minimum image height must be less than or equal to the "
                    . " maximum image height, but {$options['minheight']} > {$this->_maxheight}");
            }
        }

        if (isset($options['minwidth'])) {
            $this->_minwidth  = (int) $options['minwidth'];
        }

        if (isset($options['minheight'])) {
            $this->_minheight = (int) $options['minheight'];
        }

        return $this;
    }

setImageWidth()

setImageWidth

(

$options

)

Sets the mimimum and maximum image width

Parameters

array

$options

The image width dimensions

Returns

Zend_Validate_File_ImageSize Provides a fluent interface

Definition at line 276 of file ImageSize.php.

    {
        $this->setImageMin($options);
        $this->setImageMax($options);

        return $this;
    }

Field Documentation

$_height

$_height

protected

Definition at line 111 of file ImageSize.php.

$_maxheight

$_maxheight

protected

Definition at line 97 of file ImageSize.php.

$_maxwidth

$_maxwidth

protected

Definition at line 83 of file ImageSize.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::WIDTH_TOO_BIG    => "Maximum allowed width for image '%value%' should be '%maxwidth%' but '%width%' detected",
        self::WIDTH_TOO_SMALL  => "Minimum expected width for image '%value%' should be '%minwidth%' but '%width%' detected",
        self::HEIGHT_TOO_BIG   => "Maximum allowed height for image '%value%' should be '%maxheight%' but '%height%' detected",
        self::HEIGHT_TOO_SMALL => "Minimum expected height for image '%value%' should be '%minheight%' but '%height%' detected",
        self::NOT_DETECTED     => "The size of image '%value%' could not be detected",
        self::NOT_READABLE     => "File '%value%' is not readable or does not exist",
    )

Definition at line 50 of file ImageSize.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'minwidth'  => '_minwidth',
        'maxwidth'  => '_maxwidth',
        'minheight' => '_minheight',
        'maxheight' => '_maxheight',
        'width'     => '_width',
        'height'    => '_height'
    )

Definition at line 62 of file ImageSize.php.

$_minheight

$_minheight

protected

Definition at line 90 of file ImageSize.php.

$_minwidth

$_minwidth

protected

Definition at line 76 of file ImageSize.php.

$_width

$_width

protected

Definition at line 104 of file ImageSize.php.

HEIGHT_TOO_BIG

const HEIGHT_TOO_BIG = 'fileImageSizeHeightTooBig'

Definition at line 42 of file ImageSize.php.

HEIGHT_TOO_SMALL

const HEIGHT_TOO_SMALL = 'fileImageSizeHeightTooSmall'

Definition at line 43 of file ImageSize.php.

NOT_DETECTED

const NOT_DETECTED = 'fileImageSizeNotDetected'

Definition at line 44 of file ImageSize.php.

NOT_READABLE

const NOT_READABLE = 'fileImageSizeNotReadable'

Definition at line 45 of file ImageSize.php.

WIDTH_TOO_BIG

const WIDTH_TOO_BIG = 'fileImageSizeWidthTooBig'

@const string Error constants

Definition at line 40 of file ImageSize.php.

WIDTH_TOO_SMALL

const WIDTH_TOO_SMALL = 'fileImageSizeWidthTooSmall'

Definition at line 41 of file ImageSize.php.

---

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

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