Zend_Validate_File_ImageSize Class Reference

Public Member Functions
	__construct ($options)
	Sets validator options.
	getImageMin ()
	Returns the set minimum image sizes.
	getImageMax ()
	Returns the set maximum image sizes.
	getImageWidth ()
	Returns the set image width sizes.
	getImageHeight ()
	Returns the set image height sizes.
	setImageMin ($options)
	Sets the minimum image size.
	setImageMax ($options)
	Sets the maximum image size.
	setImageWidth ($options)
	Sets the mimimum and maximum image width.
	setImageHeight ($options)
	Sets the mimimum and maximum image height.
	isValid ($value, $file=null)
	Defined by Zend_Validate_Interface.
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	Returns array of validation failure messages.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	getErrors ()
	Returns array of validation failure message codes.
	setObscureValue ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	getObscureValue ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator ($translator=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)
	Returns true if and only if $value meets the validation requirements.

Public Attributes
const	WIDTH_TOO_BIG = 'fileImageSizeWidthTooBig'
	string Error constants
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)
	Throws an error of the given type.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.

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)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options

)

Sets validator options.

Accepts the following option keys:

• minheight
• minwidth
• maxheight
• maxwidth

Parameters

Zend_Config | array

$options

Returns

void

Member Function Documentation

_throw (   $file,   $errorType  )

protected

Throws an error of the given type.

Parameters

string	$file
string	$errorType

Returns

false

getImageHeight

(

)

Returns the set image height sizes.

Returns

array

getImageMax

(

)

Returns the set maximum image sizes.

Returns

array

getImageMin

(

)

Returns the set minimum image sizes.

Returns

array

getImageWidth

(

)

Returns the set image width sizes.

Returns

array

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

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

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

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

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

Member Data Documentation

$_height

protected

$_maxheight

protected

$_maxwidth

protected

$_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",
    )

$_messageVariables

protected

Initial value:

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

$_minheight

protected

$_minwidth

protected

$_width

protected

const HEIGHT_TOO_BIG = 'fileImageSizeHeightTooBig'

const HEIGHT_TOO_SMALL = 'fileImageSizeHeightTooSmall'

const NOT_DETECTED = 'fileImageSizeNotDetected'

const NOT_READABLE = 'fileImageSizeNotReadable'

const WIDTH_TOO_BIG = 'fileImageSizeWidthTooBig'

string Error constants

const WIDTH_TOO_SMALL = 'fileImageSizeWidthTooSmall'