Validate/File/FilesSize.php
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: FilesSize.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Validate_File_FilesSize
- Parent(s)
- \Zend_Validate_File_Size < \Zend_Validate_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

NOT_FOUND
= 'fileSizeNotFound'
- Inherited_from
- \Zend_Validate_File_Size::NOT_FOUND
Properties


\Zend_Translate $_defaultTranslator
- Type
- \Zend_Translate
- Inherited_from
- \Zend_Validate_Abstract::$$_defaultTranslator
- Inherited_from
- \Zend_Validate_File_Size::$$_defaultTranslator


array $_errors = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Validate_Abstract::$$_errors
- Inherited_from
- \Zend_Validate_File_Size::$$_errors


integer|null $_max
If null, there is no maximum filesize
- Type
- integer | null
- Inherited_from
- \Zend_Validate_File_Size::$$_max


Integer $_messageLength = -1
-1
Details- Type
- Integer
- Inherited_from
- \Zend_Validate_Abstract::$$_messageLength
- Inherited_from
- \Zend_Validate_File_Size::$$_messageLength


array $_messageTemplates = array(self::TOO_BIG => "All files in sum should have a maximum size of '%max%' but '%size%' were detected", self::TOO_SMALL => "All files in sum should have a minimum size of '%min%' but '%size%' were detected", self::NOT_READABLE => "One or more files can not be read")
array(self::TOO_BIG => "All files in sum should have a maximum size of '%max%' but '%size%' were detected", self::TOO_SMALL => "All files in sum should have a minimum size of '%min%' but '%size%' were detected", self::NOT_READABLE => "One or more files can not be read")
Details- Type
- array


array $_messageVariables = array('min' => '_min', 'max' => '_max', 'size' => '_size')
array('min' => '_min', 'max' => '_max', 'size' => '_size')
Details- Type
- array
- Inherited_from
- \Zend_Validate_File_Size::$$_messageVariables


array $_messages = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Validate_Abstract::$$_messages
- Inherited_from
- \Zend_Validate_File_Size::$$_messages


bool $_obscureValue = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Validate_Abstract::$$_obscureValue
- Inherited_from
- \Zend_Validate_File_Size::$$_obscureValue


\Zend_Translate $_translator
- Type
- \Zend_Translate
- Inherited_from
- \Zend_Validate_Abstract::$$_translator
- Inherited_from
- \Zend_Validate_File_Size::$$_translator


Boolean $_translatorDisabled = false
false
Details- Type
- Boolean
- Inherited_from
- \Zend_Validate_Abstract::$$_translatorDisabled
- Inherited_from
- \Zend_Validate_File_Size::$$_translatorDisabled


boolean $_useByteString = true
true
Details- Type
- boolean
- Inherited_from
- \Zend_Validate_File_Size::$$_useByteString


mixed $_value
- Type
- mixed
- Inherited_from
- \Zend_Validate_Abstract::$$_value
- Inherited_from
- \Zend_Validate_File_Size::$$_value
Methods


__construct(integer | array | \Zend_Config $options) : void
Sets validator options
Min limits the used diskspace for all files, when used with max=null it is the maximum filesize It also accepts an array with the keys 'min' and 'max'
Name | Type | Description |
---|---|---|
$options | integer | array | \Zend_Config | Options for this validator |


__get(string $property) : mixed
Magic 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()\Zend_Validate_File_Size::__get()Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Validate_Exception |


_createMessage(string $messageKey, string $value) : string
Constructs and returns a validation failure message with the given message key and value.
Inherited from: \Zend_Validate_Abstract::_createMessage()\Zend_Validate_File_Size::_createMessage()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.
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string |
Type | Description |
---|---|
string |


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


_fromByteString(string $size) : integer
Name | Type | Description |
---|---|---|
$size | string |
Type | Description |
---|---|
integer |


_setSize(int $size) : \Zend_Validate_File_Size
Name | Type | Description |
---|---|---|
$size | int |
Type | Description |
---|---|
\Zend_Validate_File_Size |


_setValue(mixed $value) : void
Sets the value to be validated and clears the messages and errors arrays
Inherited from: \Zend_Validate_Abstract::_setValue()\Zend_Validate_File_Size::_setValue()Name | Type | Description |
---|---|---|
$value | mixed |


_throw(string $file, string $errorType) : false
Name | Type | Description |
---|---|---|
$file | string | |
$errorType | string |
Type | Description |
---|---|
false |


_toByteString(integer $size) : string
Name | Type | Description |
---|---|---|
$size | integer |
Type | Description |
---|---|
string |


getDefaultTranslator() : \Zend_Translate_Adapter | null
Get default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()\Zend_Validate_File_Size::getDefaultTranslator()Type | Description |
---|---|
\Zend_Translate_Adapter | null |


getErrors() : array
Returns array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::getErrors()\Zend_Validate_File_Size::getErrors()Type | Description |
---|---|
array |


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


getMessageLength() : integer
Returns the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::getMessageLength()\Zend_Validate_File_Size::getMessageLength()Type | Description |
---|---|
integer |


getMessageTemplates() : array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::getMessageTemplates()\Zend_Validate_File_Size::getMessageTemplates()Type | Description |
---|---|
array |


getMessageVariables() : array
Returns an array of the names of variables that are used in constructing validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessageVariables()\Zend_Validate_File_Size::getMessageVariables()Type | Description |
---|---|
array |


getMessages() : array
Returns array of validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessages()\Zend_Validate_File_Size::getMessages()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.
Type | Description |
---|---|
array |


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


getObscureValue() : bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::getObscureValue()\Zend_Validate_File_Size::getObscureValue()Type | Description |
---|---|
bool |


getTranslator() : \Zend_Translate_Adapter | null
Return translation object
Inherited from: \Zend_Validate_Abstract::getTranslator()\Zend_Validate_File_Size::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapter | null |


hasDefaultTranslator() : boolean
Is there a default translation object set?
Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()\Zend_Validate_File_Size::hasDefaultTranslator()Type | Description |
---|---|
boolean |


hasTranslator() : bool
Does this validator have its own specific translator?
Inherited from: \Zend_Validate_Abstract::hasTranslator()\Zend_Validate_File_Size::hasTranslator()Type | Description |
---|---|
bool |


isValid(string | array $value, array $file = null) : boolean
Defined by Zend_Validate_Interface
Returns true if and only if the disk usage of all files is at least min and not bigger than max (when max is not null).
Name | Type | Description |
---|---|---|
$value | string | array | Real file to check for size |
$file | array | File data from Zend_File_Transfer |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |


setDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void
Set default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()\Zend_Validate_File_Size::setDefaultTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate | \Zend_Translate_Adapter | null |


setDisableTranslator(bool $flag) : \Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Inherited from: \Zend_Validate_Abstract::setDisableTranslator()\Zend_Validate_File_Size::setDisableTranslator()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setMax(integer $max) : \Zend_Validate_StringLength
Name | Type | Description |
---|---|---|
$max | integer | The maximum filesize |
Type | Description |
---|---|
\Zend_Validate_StringLength | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception | When max is smaller than min |


setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
Sets the validation failure message template for a particular key
Inherited from: \Zend_Validate_Abstract::setMessage()\Zend_Validate_File_Size::setMessage()Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Type | Description |
---|---|
\Zend_Validate_Abstract | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception |


setMessageLength(integer $length = -1) : void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::setMessageLength()\Zend_Validate_File_Size::setMessageLength()Name | Type | Description |
---|---|---|
$length | integer |


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


setMin(integer $min) : \Zend_Validate_File_Size
Name | Type | Description |
---|---|---|
$min | integer | The minimum filesize |
Type | Description |
---|---|
\Zend_Validate_File_Size | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception | When min is greater than max |


setObscureValue(bool $flag) : \Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::setObscureValue()\Zend_Validate_File_Size::setObscureValue()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract
Set translation object
Inherited from: \Zend_Validate_Abstract::setTranslator()\Zend_Validate_File_Size::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate | \Zend_Translate_Adapter | null |
Type | Description |
---|---|
\Zend_Validate_Abstract |


setUseByteString(boolean $byteString = true) : integer
Name | Type | Description |
---|---|---|
$byteString | boolean | Use bytestring ? |
Type | Description |
---|---|
integer |


translatorIsDisabled() : bool
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()\Zend_Validate_File_Size::translatorIsDisabled()Type | Description |
---|---|
bool |