Validate/File/Size.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Validate
- Version
- $Id: Size.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Validate_File_Size
Package: Zend\ValidateValidator for the maximum size of a file up to a max of 2GB
- Parent(s)
- \Zend_Validate_Abstract
- Children
- \Zend_Validate_File_FilesSize
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants


TOO_BIG
= 'fileSizeTooBig'


TOO_SMALL
= 'fileSizeTooSmall'


NOT_FOUND
= 'fileSizeNotFound'
Properties



array $_messageTemplates = 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")
Validation failure message template definitions
Default valuearray(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")
Details- Type
- array



array $_messageVariables = array('min' => '_min', 'max' => '_max', 'size' => '_size')
Additional variables available for validation failure messages
Default valuearray('min' => '_min', 'max' => '_max', 'size' => '_size')
Details- Type
- array
Methods



__construct(integer | array $options) : void
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
ParametersName | Type | Description |
---|
$options | integer | array | Options for the adapter |
---|



__get(string $property) : mixed
inheritedMagic function returns the value of the requested property, if and only if it is the value or a
message variable.
Inherited from:
\Zend_Validate_Abstract::__get() ParametersName | Type | Description |
---|
$property | string | |
---|
ReturnsThrows 


_createMessage(string $messageKey, string $value) : string
Returns null if and only if $messageKey does not correspond to an existing template.
If a translator is available and a translation exists for $messageKey,
the translation will be used.
ParametersName | Type | Description |
---|
$messageKey | string | |
---|
$value | string | |
---|
Returns


_error(string $messageKey, string $value = null) : void
ParametersName | Type | Description |
---|
$messageKey | string | |
---|
$value | string | OPTIONAL |
---|



_fromByteString(string $size) : integer
Returns the unformatted size
ParametersName | Type | Description |
---|
$size | string | |
---|
Returns 


_throw(string $file, string $errorType) : false
Throws an error of the given type
ParametersName | Type | Description |
---|
$file | string | |
---|
$errorType | string | |
---|
Returns 


_toByteString(integer $size) : string
Returns the formatted size
ParametersName | Type | Description |
---|
$size | integer | |
---|
Returns 


getMax(bool $raw = false) : integer | string
Returns the maximum filesize
ParametersName | Type | Description |
---|
$raw | bool | Whether or not to force return of the raw value (defaults off)
|
---|
ReturnsType | Description |
---|
integer | string | |



getMessages() : array
The array keys are validation failure message identifiers,
and the array values are the corresponding human-readable message strings.
If isValid() was never called or if the most recent isValid() call
returned true, then this method returns an empty array.
Returns


getMin(bool $raw = false) : integer | string
Returns the minimum filesize
ParametersName | Type | Description |
---|
$raw | bool | Whether or not to force return of the raw value (defaults off)
|
---|
ReturnsType | Description |
---|
integer | string | |



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).
ParametersName | Type | Description |
---|
$value | string | Real file to check for size |
---|
$file | array | File data from Zend_File_Transfer |
---|
ReturnsThrows


setMax(integer $max) : \Zend_Validate_StringLength
Sets the maximum filesize
ParametersName | Type | Description |
---|
$max | integer | The maximum filesize |
---|
ReturnsThrows 


setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
ParametersName | Type | Description |
---|
$messageString | string | |
---|
$messageKey | string | OPTIONAL |
---|
ReturnsThrows 


setMessages(array $messages) : \Zend_Validate_Abstract
inheritedSets 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.
Inherited from:
\Zend_Validate_Abstract::setMessages() ParametersName | Type | Description |
---|
$messages | array | |
---|
Returns 


setMin(integer $min) : \Zend_Validate_File_Size
Sets the minimum filesize
ParametersName | Type | Description |
---|
$min | integer | The minimum filesize |
---|
ReturnsThrows 


setUseByteString(boolean $byteString = true) : integer
Returns the minimum filesize
ParametersName | Type | Description |
---|
$byteString | boolean | Use bytestring ?
|
---|
Returns