Validate/File/ImageSize.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
version: $Id: ImageSize.php 22697 2010-07-26 21:14:47Z alexander $
Classes: Zend_Validate_File_ImageSize

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Validate_File_ImageSize
jump to top

Extends from: Zend_Validate_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Validate
Constants: WIDTH_TOO_BIG; WIDTH_TOO_SMALL; HEIGHT_TOO_BIG; HEIGHT_TOO_SMALL; NOT_DETECTED; NOT_READABLE
Properties: $_messageTemplates; $_messageVariables; $_minwidth; $_maxwidth; $_minheight; $_maxheight; $_width; $_height
Methods: __construct; getImageMin; getImageMax; getImageWidth; getImageHeight; setImageMin; setImageMax; setImageWidth; setImageHeight; isValid; _throw

Description

Validator for the image size of a image file

Constants

WIDTH_TOO_BIG
jump to class

 WIDTH_TOO_BIG = 'fileImageSizeWidthTooBig'

Details

value: fileImageSizeWidthTooBig
const: string Error constants

WIDTH_TOO_SMALL
jump to class

 WIDTH_TOO_SMALL = 'fileImageSizeWidthTooSmall'

Details

value: fileImageSizeWidthTooSmall

HEIGHT_TOO_BIG
jump to class

 HEIGHT_TOO_BIG = 'fileImageSizeHeightTooBig'

Details

value: fileImageSizeHeightTooBig

HEIGHT_TOO_SMALL
jump to class

 HEIGHT_TOO_SMALL = 'fileImageSizeHeightTooSmall'

Details

value: fileImageSizeHeightTooSmall

NOT_DETECTED
jump to class

 NOT_DETECTED = 'fileImageSizeNotDetected'

Details

value: fileImageSizeNotDetected

NOT_READABLE
jump to class

 NOT_READABLE = 'fileImageSizeNotReadable'

Details

value: fileImageSizeNotReadable

Properties

$_height
jump to class

integer $_height = ''

Detected height

Details

$_height: integer
visibility: protected
default
final: false
static: false

$_maxheight
jump to class

integer $_maxheight = ''

Maximum image height

Details

$_maxheight: integer
visibility: protected
default
final: false
static: false

$_maxwidth
jump to class

integer $_maxwidth = ''

Maximum image width

Details

$_maxwidth: integer
visibility: protected
default
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Details

$_messageTemplates: array
Error message template
visibility: protected
default: array
final: false
static: false

$_messageVariables
jump to class

array $_messageVariables = 'array'

Details

$_messageVariables: array
Error message template variables
visibility: protected
default: array
final: false
static: false

$_minheight
jump to class

integer $_minheight = ''

Minimum image height

Details

$_minheight: integer
visibility: protected
default
final: false
static: false

$_minwidth
jump to class

integer $_minwidth = ''

Minimum image width

Details

$_minwidth: integer
visibility: protected
default
final: false
static: false

$_width
jump to class

integer $_width = ''

Detected width

Details

$_width: integer
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          Zend_Config|array $options
          )
        
        :
        void

Sets validator options

Accepts the following option keys: - minheight - minwidth - maxheight - maxwidth

Arguments

$options: Zend_Configarray

Details

visibility: public
final: false
static: false

_throw
jump to class

_throw(
          string $file, string $errorType
          )
        
        :
        false

Throws an error of the given type

Arguments

$file: string
$errorType: string

Output

false

Details

visibility: protected
final: false
static: false

getImageHeight
jump to class

getImageHeight(
          
          )
        
        :
        array

Returns the set image height sizes

Output

array

Details

visibility: public
final: false
static: false

getImageMax
jump to class

getImageMax(
          
          )
        
        :
        array

Returns the set maximum image sizes

Output

array

Details

visibility: public
final: false
static: false

getImageMin
jump to class

getImageMin(
          
          )
        
        :
        array

Returns the set minimum image sizes

Output

array

Details

visibility: public
final: false
static: false

getImageWidth
jump to class

getImageWidth(
          
          )
        
        :
        array

Returns the set image width sizes

Output

array

Details

visibility: public
final: false
static: false

isValid
jump to class

isValid(
          string $value, array $file
              =
              null
          )
        
        :
        boolean

Defined by Zend_Validate_Interface

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

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

setImageHeight
jump to class

setImageHeight(
          array $options
          )
        
        :
        Zend_Validate_File_ImageSize

Sets the mimimum and maximum image height

Arguments

$options: array
The image height dimensions

Output

Zend_Validate_File_ImageSize: Provides a fluent interface

Details

visibility: public
final: false
static: false

setImageMax
jump to class

setImageMax(
          array $options
          )
        
        :
        Zend_Validate_StringLength

Sets the maximum image size

Arguments

$options: array
The maximum image dimensions

Output

Zend_Validate_StringLength: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws: When maxwidth is smaller than minwidth
throws: When maxheight is smaller than minheight

setImageMin
jump to class

setImageMin(
          array $options
          )
        
        :
        Zend_Validate_File_ImageSize

Sets the minimum image size

Arguments

$options: array
The minimum image dimensions

Output

Zend_Validate_File_ImageSize: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws: When minwidth is greater than maxwidth
throws: When minheight is greater than maxheight

setImageWidth
jump to class

setImageWidth(
          array $options
          )
        
        :
        Zend_Validate_File_ImageSize

Sets the mimimum and maximum image width

Arguments

$options: array
The image width dimensions

Output

Zend_Validate_File_ImageSize: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Validate/File/ImageSize.php

Description

Zend_Validate_File_ImageSizejump to top

Description

Constants

WIDTH_TOO_BIGjump to class

Details

WIDTH_TOO_SMALLjump to class

Details

HEIGHT_TOO_BIGjump to class

Details

HEIGHT_TOO_SMALLjump to class

Details

NOT_DETECTEDjump to class

Details

NOT_READABLEjump to class

Details

Properties

$_heightjump to class

Details

$_maxheightjump to class

Details

$_maxwidthjump to class

Details

$_messageTemplatesjump to class

Details

$_messageVariablesjump to class

Details

$_minheightjump to class

Details

$_minwidthjump to class

Details

$_widthjump to class

Details

Methods

__constructjump to class

Arguments

Details

_throwjump to class

Arguments

Output

Details

getImageHeightjump to class

Output

Details

getImageMaxjump to class

Output

Details

getImageMinjump to class

Output

Details

getImageWidthjump to class

Output

Details

isValidjump to class

Arguments

Output

Details

setImageHeightjump to class

Arguments

Output

Details

setImageMaxjump to class

Arguments

Output

Details

setImageMinjump to class

Arguments

Output

Details

setImageWidthjump to class

Arguments

Output

Details

Zend_Validate_File_ImageSize
jump to top

WIDTH_TOO_BIG
jump to class

WIDTH_TOO_SMALL
jump to class

HEIGHT_TOO_BIG
jump to class

HEIGHT_TOO_SMALL
jump to class

NOT_DETECTED
jump to class

NOT_READABLE
jump to class

$_height
jump to class

$_maxheight
jump to class

$_maxwidth
jump to class

$_messageTemplates
jump to class

$_messageVariables
jump to class

$_minheight
jump to class

$_minwidth
jump to class

$_width
jump to class

__construct
jump to class

_throw
jump to class

getImageHeight
jump to class

getImageMax
jump to class

getImageMin
jump to class

getImageWidth
jump to class

isValid
jump to class

setImageHeight
jump to class

setImageMax
jump to class

setImageMin
jump to class

setImageWidth
jump to class