Validate/File/FilesSize.php

Show:

inherited

Classes
- \Zend_Validate_File_FilesSize

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: FilesSize.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Validate_File_FilesSize
jump to top

Package: Zend\Validate

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

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

 
                TOO_BIG
                = 'fileFilesSizeTooBig'

Const: string Error constants

 
                TOO_SMALL
                = 'fileFilesSizeTooSmall'

 
                NOT_READABLE
                = 'fileFilesSizeNotReadable'

 
                NOT_FOUND
                = 'fileSizeNotFound'

inheritedInherited from: \Zend_Validate_File_Size::NOT_FOUND

Inherited_from: \Zend_Validate_File_Size::NOT_FOUND

Properties

\Zend_Translate $_defaultTranslator

staticinherited

Default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator \Zend_Validate_File_Size::$$_defaultTranslator

Details

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

array $_errors = array()

inherited

Array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::$$_errors \Zend_Validate_File_Size::$$_errors

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_errors
Inherited_from: \Zend_Validate_File_Size::$$_errors

array $_files

Internal file array

Details

Type: array

integer|null $_max

inherited

Maximum filesize

Inherited from: \Zend_Validate_File_Size::$$_max

If null, there is no maximum filesize

Details

Type: integer | null
Inherited_from: \Zend_Validate_File_Size::$$_max

Integer $_messageLength = -1

staticinherited

Limits the maximum returned length of a error message

Inherited from: \Zend_Validate_Abstract::$$_messageLength \Zend_Validate_File_Size::$$_messageLength

Default value-1Details

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")

Validation failure message template definitions

Default value

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

inherited

Additional variables available for validation failure messages

Inherited from: \Zend_Validate_File_Size::$$_messageVariables

Default valuearray('min' => '_min', 'max' => '_max', 'size' => '_size')Details

Type: array
Inherited_from: \Zend_Validate_File_Size::$$_messageVariables

array $_messages = array()

inherited

Array of validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messages \Zend_Validate_File_Size::$$_messages

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messages
Inherited_from: \Zend_Validate_File_Size::$$_messages

integer $_min

inherited

Minimum filesize

Inherited from: \Zend_Validate_File_Size::$$_min

Details

Type: integer
Inherited_from: \Zend_Validate_File_Size::$$_min

bool $_obscureValue = false

inherited

Flag indidcating whether or not value should be obfuscated in error messages

Inherited from: \Zend_Validate_Abstract::$$_obscureValue \Zend_Validate_File_Size::$$_obscureValue

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Validate_Abstract::$$_obscureValue
Inherited_from: \Zend_Validate_File_Size::$$_obscureValue

integer $_size

inherited

Detected size

Inherited from: \Zend_Validate_File_Size::$$_size

Details

Type: integer
Inherited_from: \Zend_Validate_File_Size::$$_size

\Zend_Translate $_translator

inherited

Translation object

Inherited from: \Zend_Validate_Abstract::$$_translator \Zend_Validate_File_Size::$$_translator

Details

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

Boolean $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled \Zend_Validate_File_Size::$$_translatorDisabled

Default valuefalseDetails

Type: Boolean
Inherited_from: \Zend_Validate_Abstract::$$_translatorDisabled
Inherited_from: \Zend_Validate_File_Size::$$_translatorDisabled

boolean $_useByteString = true

inherited

Use bytestring ?

Inherited from: \Zend_Validate_File_Size::$$_useByteString

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Validate_File_Size::$$_useByteString

mixed $_value

inherited

The value to be validated

Inherited from: \Zend_Validate_Abstract::$$_value \Zend_Validate_File_Size::$$_value

Details

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'

Parameters

Name	Type	Description
$options	integer \| array \| \Zend_Config	Options for this validator

__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()\Zend_Validate_File_Size::__get()

Parameters

Name	Type	Description
$property	string

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Validate_Exception

_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()\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.

Parameters

Name	Type	Description
$messageKey	string
$value	string

Returns

Type	Description
string

_error(string $messageKey, string $value = null) : void

inherited

Inherited from: \Zend_Validate_Abstract::_error()\Zend_Validate_File_Size::_error()

Parameters

Name	Type	Description
$messageKey	string
$value	string	OPTIONAL

_fromByteString(string $size) : integer

inherited

Returns the unformatted size

Inherited from: \Zend_Validate_File_Size::_fromByteString()

Parameters

Name	Type	Description
$size	string

Returns

Type	Description
integer

_getSize() : int

inherited

Retrieve current detected file size

Inherited from: \Zend_Validate_File_Size::_getSize()

Returns

Type	Description
int

_setSize(int $size) : \Zend_Validate_File_Size

inherited

Set current size

Inherited from: \Zend_Validate_File_Size::_setSize()

Parameters

Name	Type	Description
$size	int

Returns

Type	Description
\Zend_Validate_File_Size

_setValue(mixed $value) : void

inherited

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

Inherited from: \Zend_Validate_Abstract::_setValue()\Zend_Validate_File_Size::_setValue()

Parameters

Name	Type	Description
$value	mixed

_throw(string $file, string $errorType) : false

inherited

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

_toByteString(integer $size) : string

inherited

Returns the formatted size

Inherited from: \Zend_Validate_File_Size::_toByteString()

Parameters

Name	Type	Description
$size	integer

Returns

Type	Description
string

getDefaultTranslator() : \Zend_Translate_Adapter | null

staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()\Zend_Validate_File_Size::getDefaultTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getErrors() : array

inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()\Zend_Validate_File_Size::getErrors()

Returns

Type	Description
array

getMax(bool $raw = false) : integer | string

inherited

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
integer \| string

getMessageLength() : integer

staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()\Zend_Validate_File_Size::getMessageLength()

Returns

Type	Description
integer

getMessageTemplates() : array

inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()\Zend_Validate_File_Size::getMessageTemplates()

Returns

Type	Description
array

getMessageVariables() : array

inherited

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()

Returns

Type	Description
array

getMessages() : array

inherited

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.

Returns

Type	Description
array

getMin(bool $raw = false) : integer | string

inherited

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
integer \| string

getObscureValue() : bool

inherited

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

Inherited from: \Zend_Validate_Abstract::getObscureValue()\Zend_Validate_File_Size::getObscureValue()

Returns

Type	Description
bool

getTranslator() : \Zend_Translate_Adapter | null

inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()\Zend_Validate_File_Size::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

hasDefaultTranslator() : boolean

staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()\Zend_Validate_File_Size::hasDefaultTranslator()

Returns

Type	Description
boolean

hasTranslator() : bool

inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()\Zend_Validate_File_Size::hasTranslator()

Returns

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).

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

setDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void

staticinherited

Set default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()\Zend_Validate_File_Size::setDefaultTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

setDisableTranslator(bool $flag) : \Zend_Validate_Abstract

inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Validate_Abstract::setDisableTranslator()\Zend_Validate_File_Size::setDisableTranslator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setMax(integer $max) : \Zend_Validate_StringLength

inherited

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

setMessage(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()\Zend_Validate_File_Size::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

setMessageLength(integer $length = -1) : void

staticinherited

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()\Zend_Validate_File_Size::setMessageLength()

Parameters

Name	Type	Description
$length	integer

setMessages(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()\Zend_Validate_File_Size::setMessages()

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Validate_Abstract

setMin(integer $min) : \Zend_Validate_File_Size

inherited

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

setObscureValue(bool $flag) : \Zend_Validate_Abstract

inherited

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

Inherited from: \Zend_Validate_Abstract::setObscureValue()\Zend_Validate_File_Size::setObscureValue()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Validate_Abstract

inherited

Set translation object

Inherited from: \Zend_Validate_Abstract::setTranslator()\Zend_Validate_File_Size::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_Validate_Abstract

setUseByteString(boolean $byteString = true) : integer

inherited

Returns the minimum filesize

Inherited from: \Zend_Validate_File_Size::setUseByteString()

Parameters

Name	Type	Description
$byteString	boolean	Use bytestring ?

Returns

Type	Description
integer

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()\Zend_Validate_File_Size::translatorIsDisabled()

Returns

Type	Description
bool

useByteString() : boolean

inherited

Will bytestring be used?

Inherited from: \Zend_Validate_File_Size::useByteString()

Returns

Type	Description
boolean

Validate/File/FilesSize.php

\Zend_Validate_File_FilesSizejump to top

Constants

Properties

Methods

\Zend_Validate_File_FilesSize
jump to top