API Documentation

Validate/File/FilesSize.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  
version
$Id: FilesSize.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Validate_File_FilesSize

Validator for the size of all files which will be validated in sum

Extends from
\Zend_Validate_File_Size
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  

Constants

Constant  TOO_BIG = 'fileFilesSizeTooBig'

const
string Error constants  
Constant  TOO_SMALL = 'fileFilesSizeTooSmall'
Constant  NOT_READABLE = 'fileFilesSizeNotReadable'

Properties

Propertyprotectedarray  $_files= ''

Internal file array

Details
Type
array
Propertyprotectedarray  $_messageTemplates= 'array'
Error message templates

Validation failure message template definitions

Default valuearrayDetails
Type
array

Methods

methodpublic__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'

Parameters
Name Type Description
$options integer|array|\Zend_Config Options for this validator
methodpublic__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()
Parameters
Name Type Description
$property string
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Validate_Exception
methodprotected_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.

Parameters
Name Type Description
$messageKey string
$value string
Returns
Type Description
string
methodprotected_error( string $messageKey, string $value = null ) : void
Parameters
Name Type Description
$messageKey string
$value string OPTIONAL
methodprotected_fromByteString( string $size ) : integer

Returns the unformatted size

Inherited from: \Zend_Validate_File_Size::_fromByteString()
Parameters
Name Type Description
$size string
Returns
Type Description
integer
methodprotected_getSize( ) : int

Retrieve current detected file size

Inherited from: \Zend_Validate_File_Size::_getSize()
Returns
Type Description
int
methodprotected_setSize( int $size ) : \Zend_Validate_File_Size

Set current size

Inherited from: \Zend_Validate_File_Size::_setSize()
Parameters
Name Type Description
$size int
Returns
Type Description
\Zend_Validate_File_Size
methodprotected_setValue( mixed $value ) : void

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

Inherited from: \Zend_Validate_Abstract::_setValue()
Parameters
Name Type Description
$value mixed
methodprotected_throw( string $file, string $errorType ) : false

Throws an error of the given type

Inherited from: \Zend_Validate_File_Size::_throw()
Parameters
Name Type Description
$file string
$errorType string
Returns
Type Description
false
methodprotected_toByteString( integer $size ) : string

Returns the formatted size

Inherited from: \Zend_Validate_File_Size::_toByteString()
Parameters
Name Type Description
$size integer
Returns
Type Description
string
methodpublicgetDefaultTranslator( ) : \Zend_Translate_Adapter|null
static

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetErrors( ) : array

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()
Returns
Type Description
array
Details
deprecated
Since 1.5.0  
methodpublicgetMax( bool $raw = false ) : integer|string

Returns the maximum filesize

Inherited from: \Zend_Validate_File_Size::getMax()
Parameters
Name Type Description
$raw bool

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

Returns
Type Description
integerstring
methodpublicgetMessageLength( ) : integer
static

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()
Returns
Type Description
integer
methodpublicgetMessageTemplates( ) : array

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()
Returns
Type Description
array
methodpublicgetMessageVariables( ) : array

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

Inherited from: \Zend_Validate_Abstract::getMessageVariables()
Returns
Type Description
array
methodpublicgetMessages( ) : 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.

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

Returns the minimum filesize

Inherited from: \Zend_Validate_File_Size::getMin()
Parameters
Name Type Description
$raw bool

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

Returns
Type Description
integerstring
methodpublicgetObscureValue( ) : bool

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

Inherited from: \Zend_Validate_Abstract::getObscureValue()
Returns
Type Description
bool
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublichasDefaultTranslator( ) : boolean
static

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
Type Description
boolean
methodpublichasTranslator( ) : bool

Does this validator have its own specific translator?

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

Parameters
Name Type Description
$value string|array Real file to check for size
$file array File data from Zend_File_Transfer
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Validate_Exception If validation of $value is impossible
methodpublicsetDefaultTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : void
static

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()
Parameters
Name Type Description
$translator \Zend_Translate|\Zend_Translate_Adapter|null
methodpublicsetDisableTranslator( bool $flag ) : \Zend_Validate_Abstract

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetMax( integer $max ) : \Zend_Validate_StringLength

Sets the maximum filesize

Inherited from: \Zend_Validate_File_Size::setMax()
Parameters
Name Type Description
$max integer The maximum filesize
Returns
Type Description
\Zend_Validate_StringLength Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception When max is smaller than min
methodpublicsetMessage( string $messageString, string $messageKey = null ) : \Zend_Validate_Abstract

Sets the validation failure message template for a particular key

Inherited from: \Zend_Validate_Abstract::setMessage()
Parameters
Name Type Description
$messageString string
$messageKey string OPTIONAL
Returns
Type Description
\Zend_Validate_Abstract Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception
methodpublicsetMessageLength( integer $length ) : void
static

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()
Parameters
Name Type Description
$length integer
methodpublicsetMessages( 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()
Parameters
Name Type Description
$messages array
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetMin( integer $min ) : \Zend_Validate_File_Size

Sets the minimum filesize

Inherited from: \Zend_Validate_File_Size::setMin()
Parameters
Name Type Description
$min integer The minimum filesize
Returns
Type Description
\Zend_Validate_File_Size Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception When min is greater than max
methodpublicsetObscureValue( bool $flag ) : \Zend_Validate_Abstract

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

Inherited from: \Zend_Validate_Abstract::setObscureValue()
Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_Validate_Abstract
methodpublicsetTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Validate_Abstract

Set translation object

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

Returns the minimum filesize

Inherited from: \Zend_Validate_File_Size::setUseByteString()
Parameters
Name Type Description
$byteString boolean

Use bytestring ?

Returns
Type Description
integer
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

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

Will bytestring be used?

Inherited from: \Zend_Validate_File_Size::useByteString()
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.