Zend Framework
Back to top  

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

 Methods

Sets validator options

__construct(int | array | \Traversable $options) 

Min limits the used disk space for all files, when used with max=null it is the maximum file size It also accepts an array with the keys 'min' and 'max'

Parameters

$options

intarray\Traversable

Options for this validator

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

__get(string $property) : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::__get()
inherited_from \Zend\Validator\File\Size::__get()

Parameters

$property

string

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

mixed

Invoke as command

__invoke(mixed $value) : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::__invoke()
inherited_from \Zend\Validator\File\Size::__invoke()

Parameters

$value

mixed

Returns

bool

Will bytestring be used?

getByteString() : bool
Inherited

inherited_from \Zend\Validator\File\Size::getByteString()

Returns

bool

Get default translation object for all validate objects

getDefaultTranslator() : \Zend\Validator\Translator\TranslatorInterface | null
Inherited

inherited_from \Zend\Validator\AbstractValidator::getDefaultTranslator()
inherited_from \Zend\Validator\File\Size::getDefaultTranslator()

Returns

\Zend\Validator\Translator\TranslatorInterfacenull

Get default translation text domain for all validate objects

getDefaultTranslatorTextDomain() : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::getDefaultTranslatorTextDomain()
inherited_from \Zend\Validator\File\Size::getDefaultTranslatorTextDomain()

Returns

string

Returns the maximum file size

getMax(bool $raw) : int | string
Inherited

inherited_from \Zend\Validator\File\Size::getMax()

Parameters

$raw

bool

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

Returns

intstring

Returns the maximum allowed message length

getMessageLength() : int
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageLength()
inherited_from \Zend\Validator\File\Size::getMessageLength()

Returns

int

Returns the message templates from the validator

getMessageTemplates() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageTemplates()
inherited_from \Zend\Validator\File\Size::getMessageTemplates()

Returns

array

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

getMessageVariables() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageVariables()
inherited_from \Zend\Validator\File\Size::getMessageVariables()

Returns

array

Returns array of validation failure messages

getMessages() : array
Inherited

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.

inherited_from \Zend\Validator\AbstractValidator::getMessages()
inherited_from \Zend\Validator\File\Size::getMessages()

Returns

array

Returns the minimum file size

getMin(bool $raw) : int | string
Inherited

inherited_from \Zend\Validator\File\Size::getMin()

Parameters

$raw

bool

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

Returns

intstring

Returns an option

getOption(string $option) : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::getOption()
inherited_from \Zend\Validator\File\Size::getOption()

Parameters

$option

string

Option to be returned

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

mixedReturned option

Returns all available options

getOptions() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getOptions()
inherited_from \Zend\Validator\File\Size::getOptions()

Returns

arrayArray with all available options

Return translation object

getTranslator() : \Zend\Validator\Translator\TranslatorInterface | null
Inherited

inherited_from \Zend\Validator\AbstractValidator::getTranslator()
inherited_from \Zend\Validator\File\Size::getTranslator()

Returns

\Zend\Validator\Translator\TranslatorInterfacenull

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::getTranslatorTextDomain()
inherited_from \Zend\Validator\File\Size::getTranslatorTextDomain()

Returns

string

Is there a default translation object set?

hasDefaultTranslator() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::hasDefaultTranslator()
inherited_from \Zend\Validator\File\Size::hasDefaultTranslator()

Returns

bool

Does this validator have its own specific translator?

hasTranslator() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::hasTranslator()
inherited_from \Zend\Validator\File\Size::hasTranslator()

Returns

bool

Is translation enabled?

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::isTranslatorEnabled()
inherited_from \Zend\Validator\File\Size::isTranslatorEnabled()

Returns

bool

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

isValid(string | array $value, array $file) : bool

If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameters

$value

stringarray

Real file to check for size

$file

array

File data from \Zend\File\Transfer\Transfer

Exceptions

\Zend\Validator\Exception\RuntimeException If validation of $value is impossible

Returns

bool

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

isValueObscured() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::isValueObscured()
inherited_from \Zend\Validator\File\Size::isValueObscured()

Returns

bool

Set default translation object for all validate objects

setDefaultTranslator(\Zend\Validator\Translator\TranslatorInterface $translator, string $textDomain) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setDefaultTranslator()
inherited_from \Zend\Validator\File\Size::setDefaultTranslator()

Parameters

$translator

\Zend\Validator\Translator\TranslatorInterfacenull

$textDomain

string

(optional)

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Set default translation text domain for all validate objects

setDefaultTranslatorTextDomain(string $textDomain) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setDefaultTranslatorTextDomain()
inherited_from \Zend\Validator\File\Size::setDefaultTranslatorTextDomain()

Parameters

$textDomain

string

Sets the maximum file size

setMax(int | string $max) : \Zend\Validator\File\Size
Inherited

File size can be an integer or a byte string This includes 'B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB' For example: 2000, 2MB, 0.2GB

inherited_from \Zend\Validator\File\Size::setMax()

Parameters

$max

intstring

The maximum file size

Exceptions

\Zend\Validator\Exception\InvalidArgumentException When max is smaller than min

Returns

\Zend\Validator\File\SizeProvides a fluent interface

Sets the validation failure message template for a particular key

setMessage(string $messageString, string $messageKey) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessage()
inherited_from \Zend\Validator\File\Size::setMessage()

Parameters

$messageString

string

$messageKey

string

OPTIONAL

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

\Zend\Validator\AbstractValidatorProvides a fluent interface

Sets the maximum allowed message length

setMessageLength(int $length) 
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessageLength()
inherited_from \Zend\Validator\File\Size::setMessageLength()

Parameters

$length

int

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.

setMessages(array $messages) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessages()
inherited_from \Zend\Validator\File\Size::setMessages()

Parameters

$messages

array

Returns

\Zend\Validator\AbstractValidator

Sets the minimum file size

setMin(int | string $min) : \Zend\Validator\File\Size
Inherited

File size can be an integer or a byte string This includes 'B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB' For example: 2000, 2MB, 0.2GB

inherited_from \Zend\Validator\File\Size::setMin()

Parameters

$min

intstring

The minimum file size

Exceptions

\Zend\Validator\Exception\InvalidArgumentException When min is greater than max

Returns

\Zend\Validator\File\SizeProvides a fluent interface

Sets one or multiple options

setOptions(array | \Traversable $options) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setOptions()
inherited_from \Zend\Validator\File\Size::setOptions()

Parameters

$options

array\Traversable

Options to set

Exceptions

\Zend\Validator\Exception\InvalidArgumentException If $options is not an array or Traversable

Returns

\Zend\Validator\AbstractValidatorProvides fluid interface

Set translation object

setTranslator(\Zend\Validator\Translator\TranslatorInterface $translator, string $textDomain) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslator()
inherited_from \Zend\Validator\File\Size::setTranslator()

Parameters

$translator

\Zend\Validator\Translator\TranslatorInterfacenull

$textDomain

string

(optional)

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

\Zend\Validator\AbstractValidator

Indicate whether or not translation should be enabled

setTranslatorEnabled(bool $flag) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslatorEnabled()
inherited_from \Zend\Validator\File\Size::setTranslatorEnabled()

Parameters

$flag

bool

Returns

\Zend\Validator\AbstractValidator

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslatorTextDomain()
inherited_from \Zend\Validator\File\Size::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

\Zend\Validator\AbstractValidator

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

setValueObscured(bool $flag) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setValueObscured()
inherited_from \Zend\Validator\File\Size::setValueObscured()

Parameters

$flag

bool

Returns

\Zend\Validator\AbstractValidator

Should messages return bytes as integer or as string in SI notation

useByteString(bool $byteString) : int
Inherited

inherited_from \Zend\Validator\File\Size::useByteString()

Parameters

$byteString

bool

Use bytestring ?

Returns

int

Constructs and returns a validation failure message with the given message key and value.

createMessage(string $messageKey, string | array | object $value) : string
Inherited

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.

inherited_from \Zend\Validator\AbstractValidator::createMessage()
inherited_from \Zend\Validator\File\Size::createMessage()

Parameters

$messageKey

string

$value

stringarrayobject

Returns

string

error() 

error(string $messageKey, string $value) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::error()
inherited_from \Zend\Validator\File\Size::error()

Parameters

$messageKey

string

$value

string

OPTIONAL

Returns the unformatted size

fromByteString(string $size) : int
Inherited

inherited_from \Zend\Validator\File\Size::fromByteString()

Parameters

$size

string

Returns

int

Retrieve current detected file size

getSize() : int
Inherited

inherited_from \Zend\Validator\File\Size::getSize()

Returns

int

Returns the validation value

getValue() : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::getValue()
inherited_from \Zend\Validator\File\Size::getValue()

Returns

mixedValue to be validated

Set current size

setSize(int $size) : \Zend\Validator\File\Size
Inherited

inherited_from \Zend\Validator\File\Size::setSize()

Parameters

$size

int

Returns

\Zend\Validator\File\Size

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

setValue(mixed $value) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setValue()
inherited_from \Zend\Validator\File\Size::setValue()

Parameters

$value

mixed

Throws an error of the given type

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

Parameters

$file

string

$errorType

string

Returns

false

Returns the formatted size

toByteString(int $size) : string
Inherited

inherited_from \Zend\Validator\File\Size::toByteString()

Parameters

$size

int

Returns

string

Translate a validation message

translateMessage(string $messageKey, string $message) : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::translateMessage()
inherited_from \Zend\Validator\File\Size::translateMessage()

Parameters

$messageKey

string

$message

string

Returns

string

 Properties

 

$abstractOptions

$abstractOptions 
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$abstractOptions
inherited_from \Zend\Validator\File\Size::$$abstractOptions
 

Default translation object for all validate objects

$defaultTranslator : \Zend\Validator\Translator\TranslatorInterface
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$defaultTranslator
inherited_from \Zend\Validator\File\Size::$$defaultTranslator
 

Default text domain to be used with translator

$defaultTranslatorTextDomain : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$defaultTranslatorTextDomain
inherited_from \Zend\Validator\File\Size::$$defaultTranslatorTextDomain
 

Internal file array

$files : array

 

Limits the maximum returned length of an error message

$messageLength : int
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$messageLength
inherited_from \Zend\Validator\File\Size::$$messageLength
 

<p>Error message templates</p>

$messageTemplates : array

 

<p>Error message template variables</p>

$messageVariables : array
Inherited

inherited_from \Zend\Validator\File\Size::$$messageVariables
 

Options for this validator

$options : array
Inherited

inherited_from \Zend\Validator\File\Size::$$options
 

Detected size

$size : int
Inherited

inherited_from \Zend\Validator\File\Size::$$size
 

The value to be validated

$value : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$value
inherited_from \Zend\Validator\File\Size::$$value

 Constants

 

NOT_FOUND

NOT_FOUND 
Inherited

inherited_from \Zend\Validator\File\Size::NOT_FOUND
 

NOT_READABLE

NOT_READABLE 

 

TOO_BIG

TOO_BIG 

const string Error constants
 

TOO_SMALL

TOO_SMALL