Validate/File/Size.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: Size.php 22697 2010-07-26 21:14:47Z alexander $
Classes: Zend_Validate_File_Size

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_Size
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: TOO_BIG; TOO_SMALL; NOT_FOUND
Properties: $_messageTemplates; $_messageVariables; $_min; $_max; $_size; $_useByteString
Methods: __construct; setUseByteString; useByteString; getMin; setMin; getMax; setMax; _getSize; _setSize; isValid; _toByteString; _fromByteString; _throw

Description

Validator for the maximum size of a file up to a max of 2GB

Constants

TOO_BIG
jump to class

 TOO_BIG = 'fileSizeTooBig'

Details

value: fileSizeTooBig

TOO_SMALL
jump to class

 TOO_SMALL = 'fileSizeTooSmall'

Details

value: fileSizeTooSmall

NOT_FOUND
jump to class

 NOT_FOUND = 'fileSizeNotFound'

Details

value: fileSizeNotFound

Properties

$_max
jump to class

integer|null $_max = ''

Maximum filesize

If null, there is no maximum filesize

Details

$_max: integer|null
visibility: protected
default
final: false
static: false

$_messageTemplates
jump to class

array $_messageTemplates = 'array'

Details

$_messageTemplates: array
Error message templates
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

$_min
jump to class

integer $_min = ''

Minimum filesize

Details

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

$_size
jump to class

integer $_size = ''

Detected size

Details

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

$_useByteString
jump to class

boolean $_useByteString = 'true'

Use bytestring ?

Details

$_useByteString: boolean
visibility: protected
default: true
final: false
static: false

Methods

__construct
jump to class

__construct(
          integer|array $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

Arguments

$options: integerarray
Options for the adapter

Details

visibility: public
final: false
static: false

_fromByteString
jump to class

_fromByteString(
          string $size
          )
        
        :
        integer

Returns the unformatted size

Arguments

$size: string

Output

integer

Details

visibility: protected
final: false
static: false

_getSize
jump to class

_getSize(
          
          )
        
        :
        int

Retrieve current detected file size

Output

int

Details

visibility: protected
final: false
static: false

_setSize
jump to class

_setSize(
          int $size
          )
        
        :
        Zend_Validate_File_Size

Set current size

Arguments

$size: int

Output

Zend_Validate_File_Size

Details

visibility: protected
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

_toByteString
jump to class

_toByteString(
          integer $size
          )
        
        :
        string

Returns the formatted size

Arguments

$size: integer

Output

string

Details

visibility: protected
final: false
static: false

getMax
jump to class

getMax(
          bool $raw
              =
              false
          )
        
        :
        integer|string

Returns the maximum filesize

Arguments

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

Output

integer|string

Details

visibility: public
final: false
static: false

getMin
jump to class

getMin(
          bool $raw
              =
              false
          )
        
        :
        integer|string

Returns the minimum filesize

Arguments

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

Output

integer|string

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 filesize of $value is at least min and not bigger than max (when max is not null).

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

setMax
jump to class

setMax(
          integer $max
          )
        
        :
        Zend_Validate_StringLength

Sets the maximum filesize

Arguments

$max: integer
The maximum filesize

Output

Zend_Validate_StringLength: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws: When max is smaller than min

setMin
jump to class

setMin(
          integer $min
          )
        
        :
        Zend_Validate_File_Size

Sets the minimum filesize

Arguments

$min: integer
The minimum filesize

Output

Zend_Validate_File_Size: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws: When min is greater than max

setUseByteString
jump to class

setUseByteString(
          boolean $byteString
              =
              true
          )
        
        :
        integer

Returns the minimum filesize

Arguments

$byteString: boolean
Use bytestring ?

Output

integer

Details

visibility: public
final: false
static: false

useByteString
jump to class

useByteString(
          
          )
        
        :
        boolean

Will bytestring be used?

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Validate/File/Size.php

Description

Zend_Validate_File_Sizejump to top

Description

Constants

TOO_BIGjump to class

Details

TOO_SMALLjump to class

Details

NOT_FOUNDjump to class

Details

Properties

$_maxjump to class

Details

$_messageTemplatesjump to class

Details

$_messageVariablesjump to class

Details

$_minjump to class

Details

$_sizejump to class

Details

$_useByteStringjump to class

Details

Methods

__constructjump to class

Arguments

Details

_fromByteStringjump to class

Arguments

Output

Details

_getSizejump to class

Output

Details

_setSizejump to class

Arguments

Output

Details

_throwjump to class

Arguments

Output

Details

_toByteStringjump to class

Arguments

Output

Details

getMaxjump to class

Arguments

Output

Details

getMinjump to class

Arguments

Output

Details

isValidjump to class

Arguments

Output

Details

setMaxjump to class

Arguments

Output

Details

setMinjump to class

Arguments

Output

Details

setUseByteStringjump to class

Arguments

Output

Details

useByteStringjump to class

Output

Details

Zend_Validate_File_Size
jump to top

TOO_BIG
jump to class

TOO_SMALL
jump to class

NOT_FOUND
jump to class

$_max
jump to class

$_messageTemplates
jump to class

$_messageVariables
jump to class

$_min
jump to class

$_size
jump to class

$_useByteString
jump to class

__construct
jump to class

_fromByteString
jump to class

_getSize
jump to class

_setSize
jump to class

_throw
jump to class

_toByteString
jump to class

getMax
jump to class

getMin
jump to class

isValid
jump to class

setMax
jump to class

setMin
jump to class

setUseByteString
jump to class

useByteString
jump to class