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.
Validator for the size of all files which will be validated in sum

__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()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()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
Returns the unformatted size
Inherited from: \Zend_Validate_File_Size::_fromByteString()Name | Type | Description |
---|---|---|
$size | string |
Type | Description |
---|---|
integer |

_getSize(
)
:
int
Retrieve current detected file size
Inherited from: \Zend_Validate_File_Size::_getSize()Type | Description |
---|---|
int |

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

_throw(
string $file, string $errorType
)
:
false
Throws an error of the given type
Inherited from: \Zend_Validate_File_Size::_throw()Name | Type | Description |
---|---|---|
$file | string | |
$errorType | string |
Type | Description |
---|---|
false |

_toByteString(
integer $size
)
:
string
Returns the formatted size
Inherited from: \Zend_Validate_File_Size::_toByteString()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()Type | Description |
---|---|
\Zend_Translate_Adapternull |

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

getMax(
bool $raw
=
false
)
:
integer|string
Returns the maximum filesize
Inherited from: \Zend_Validate_File_Size::getMax()Name | Type | Description |
---|---|---|
$raw | bool | Whether or not to force return of the raw value (defaults off) |
Type | Description |
---|---|
integerstring |

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

getMessageTemplates(
)
:
array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::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()Type | Description |
---|---|
array |

getMessages(
)
:
array
Returns array of validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessages()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
Returns the minimum filesize
Inherited from: \Zend_Validate_File_Size::getMin()Name | Type | Description |
---|---|---|
$raw | bool | Whether or not to force return of the raw value (defaults off) |
Type | Description |
---|---|
integerstring |

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

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

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

hasTranslator(
)
:
bool
Does this validator have its own specific translator?
Inherited from: \Zend_Validate_Abstract::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()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()
setMax(
integer $max
)
:
\Zend_Validate_StringLength
Sets the maximum filesize
Inherited from: \Zend_Validate_File_Size::setMax()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()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
)
:
void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::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()
setMin(
integer $min
)
:
\Zend_Validate_File_Size
Sets the minimum filesize
Inherited from: \Zend_Validate_File_Size::setMin()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()
setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
\Zend_Validate_Abstract
Set translation object
Inherited from: \Zend_Validate_Abstract::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Validate_Abstract |

setUseByteString(
boolean $byteString
=
true
)
:
integer
Returns the minimum filesize
Inherited from: \Zend_Validate_File_Size::setUseByteString()Name | Type | Description |
---|---|---|
$byteString | boolean | Use bytestring ? |
Type | Description |
---|---|
integer |

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

useByteString(
)
:
boolean
Will bytestring be used?
Inherited from: \Zend_Validate_File_Size::useByteString()Type | Description |
---|---|
boolean |