Validate/File/Size.php

Show: PublicProtectedPrivateinherited
Table of Contents
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\Validate
Validator 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

>VConstant  TOO_BIG = 'fileSizeTooBig'
>VConstant  TOO_SMALL = 'fileSizeTooSmall'
>VConstant  NOT_FOUND = 'fileSizeNotFound'

Properties

>VPropertyprotected\Zend_Translate $_defaultTranslator
staticinherited
Default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator
>VPropertyprotectedarray $_errors = array()
inherited
Array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::$$_errors
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_errors  
>VPropertyprotectedinteger|null $_max
Maximum filesize

If null, there is no maximum filesize

Details
Type
integer | null
>VPropertyprotectedInteger $_messageLength = -1
staticinherited
Limits the maximum returned length of a error message
Inherited from: \Zend_Validate_Abstract::$$_messageLength
Default value-1Details
Type
Integer
Inherited_from
\Zend_Validate_Abstract::$$_messageLength  
>VPropertyprotectedarray $_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
>VPropertyprotectedarray $_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
>VPropertyprotectedarray $_messages = array()
inherited
Array of validation failure messages
Inherited from: \Zend_Validate_Abstract::$$_messages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Validate_Abstract::$$_messages  
>VPropertyprotectedinteger $_min
Minimum filesize
Details
Type
integer
>VPropertyprotectedbool $_obscureValue = false
inherited
Flag indidcating whether or not value should be obfuscated in error messages
Inherited from: \Zend_Validate_Abstract::$$_obscureValue
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Validate_Abstract::$$_obscureValue  
>VPropertyprotectedinteger $_size
Detected size
Details
Type
integer
>VPropertyprotected\Zend_Translate $_translator
inherited
Translation object
Inherited from: \Zend_Validate_Abstract::$$_translator
>VPropertyprotectedBoolean $_translatorDisabled = false
inherited
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled
Default valuefalseDetails
Type
Boolean
Inherited_from
\Zend_Validate_Abstract::$$_translatorDisabled  
>VPropertyprotectedboolean $_useByteString = true
Use bytestring ?
Default valuetrueDetails
Type
boolean
>VPropertyprotectedmixed $_value
inherited
The value to be validated
Inherited from: \Zend_Validate_Abstract::$$_value
Details
Type
mixed
Inherited_from
\Zend_Validate_Abstract::$$_value  

Methods

methodpublic__construct(integer | array $options) : void

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

Parameters
NameTypeDescription
$optionsinteger | array

Options for the adapter

methodpublic__get(string $property) : mixed
inherited

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()
Parameters
NameTypeDescription
$propertystring
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Validate_Exception
methodprotected_createMessage(string $messageKey, string $value) : string
inherited

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.

Parameters
NameTypeDescription
$messageKeystring
$valuestring
Returns
TypeDescription
string
methodprotected_error(string $messageKey, string $value = null) : void
inherited

Inherited from: \Zend_Validate_Abstract::_error()
Parameters
NameTypeDescription
$messageKeystring
$valuestring

OPTIONAL

methodprotected_fromByteString(string $size) : integer

Returns the unformatted size

Parameters
NameTypeDescription
$sizestring
Returns
TypeDescription
integer
methodprotected_getSize() : int

Retrieve current detected file size

Returns
TypeDescription
int
methodprotected_setSize(int $size) : \Zend_Validate_File_Size

Set current size

Parameters
NameTypeDescription
$sizeint
Returns
TypeDescription
\Zend_Validate_File_Size
methodprotected_setValue(mixed $value) : void
inherited

Sets the value to be validated and clears the messages and errors arrays

Inherited from: \Zend_Validate_Abstract::_setValue()
Parameters
NameTypeDescription
$valuemixed
methodprotected_throw(string $file, string $errorType) : false

Throws an error of the given type

Parameters
NameTypeDescription
$filestring
$errorTypestring
Returns
TypeDescription
false
methodprotected_toByteString(integer $size) : string

Returns the formatted size

Parameters
NameTypeDescription
$sizeinteger
Returns
TypeDescription
string
methodpublicgetDefaultTranslator() : \Zend_Translate_Adapter | null
staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublicgetErrors() : array
inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()
Returns
TypeDescription
array
methodpublicgetMax(bool $raw = false) : integer | string

Returns the maximum filesize

Parameters
NameTypeDescription
$rawbool

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

Returns
TypeDescription
integer | string
methodpublicgetMessageLength() : integer
staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()
Returns
TypeDescription
integer
methodpublicgetMessageTemplates() : array
inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()
Returns
TypeDescription
array
methodpublicgetMessageVariables() : array
inherited

Returns an array of the names of variables that are used in constructing validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessageVariables()
Returns
TypeDescription
array
methodpublicgetMessages() : array
inherited

Returns array of validation failure messages

Inherited from: \Zend_Validate_Abstract::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.

Returns
TypeDescription
array
methodpublicgetMin(bool $raw = false) : integer | string

Returns the minimum filesize

Parameters
NameTypeDescription
$rawbool

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

Returns
TypeDescription
integer | string
methodpublicgetObscureValue() : bool
inherited

Retrieve flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::getObscureValue()
Returns
TypeDescription
bool
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublichasDefaultTranslator() : boolean
staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
TypeDescription
boolean
methodpublichasTranslator() : bool
inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()
Returns
TypeDescription
bool
methodpublicisValid(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).

Parameters
NameTypeDescription
$valuestring

Real file to check for size

$filearray

File data from Zend_File_Transfer

Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicsetDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void
staticinherited

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
methodpublicsetDisableTranslator(bool $flag) : \Zend_Validate_Abstract
inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetMax(integer $max) : \Zend_Validate_StringLength

Sets the maximum filesize

Parameters
NameTypeDescription
$maxinteger

The maximum filesize

Returns
TypeDescription
\Zend_Validate_StringLengthProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionWhen max is smaller than min
methodpublicsetMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
inherited

Sets the validation failure message template for a particular key

Inherited from: \Zend_Validate_Abstract::setMessage()
Parameters
NameTypeDescription
$messageStringstring
$messageKeystring

OPTIONAL

Returns
TypeDescription
\Zend_Validate_AbstractProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_Exception
methodpublicsetMessageLength(integer $length = -1) : void
staticinherited

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()
Parameters
NameTypeDescription
$lengthinteger
methodpublicsetMessages(array $messages) : \Zend_Validate_Abstract
inherited

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()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetMin(integer $min) : \Zend_Validate_File_Size

Sets the minimum filesize

Parameters
NameTypeDescription
$mininteger

The minimum filesize

Returns
TypeDescription
\Zend_Validate_File_SizeProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionWhen min is greater than max
methodpublicsetObscureValue(bool $flag) : \Zend_Validate_Abstract
inherited

Set flag indicating whether or not value should be obfuscated in messages

Inherited from: \Zend_Validate_Abstract::setObscureValue()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract
inherited

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
Returns
TypeDescription
\Zend_Validate_Abstract
methodpublicsetUseByteString(boolean $byteString = true) : integer

Returns the minimum filesize

Parameters
NameTypeDescription
$byteStringboolean

Use bytestring ?

Returns
TypeDescription
integer
methodpublictranslatorIsDisabled() : bool
inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()
Returns
TypeDescription
bool
methodpublicuseByteString() : boolean

Will bytestring be used?

Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.