| Fully Qualified Name: | Laminas\Validator\File\FilesSize |
| Extends: | Size |
Validator for the size of all files which will be validated in sum
| Name | Description | Defined By |
|---|---|---|
| __construct() | Sets validator options | FilesSize |
| __get() | Magic function returns the value of the requested property, if and only if it is the value or a message variable. | AbstractValidator |
| __invoke() | Invoke as command | AbstractValidator |
| getByteString() | Will bytestring be used? | Size |
| getDefaultTranslator() | Get default translation object for all validate objects | AbstractValidator |
| getDefaultTranslatorTextDomain() | Get default translation text domain for all validate objects | AbstractValidator |
| getMax() | Returns the maximum file size | Size |
| getMessageLength() | Returns the maximum allowed message length | AbstractValidator |
| getMessageTemplates() | Returns the message templates from the validator | AbstractValidator |
| getMessageVariables() | Returns an array of the names of variables that are used in constructing validation failure messages | AbstractValidator |
| getMessages() | Returns array of validation failure messages | AbstractValidator |
| getMin() | Returns the minimum file size | Size |
| getOption() | Returns an option | AbstractValidator |
| getOptions() | Returns all available options | AbstractValidator |
| getTranslator() | Return translation object | AbstractValidator |
| getTranslatorTextDomain() | Return the translation text domain | AbstractValidator |
| hasDefaultTranslator() | Is there a default translation object set? | AbstractValidator |
| hasTranslator() | Does this validator have its own specific translator? | AbstractValidator |
| isTranslatorEnabled() | Is translation enabled? | AbstractValidator |
| isValid() | 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). | FilesSize |
| isValueObscured() | Retrieve flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
| setDefaultTranslator() | Set default translation object for all validate objects | AbstractValidator |
| setDefaultTranslatorTextDomain() | Set default translation text domain for all validate objects | AbstractValidator |
| setMax() | Sets the maximum file size | Size |
| setMessage() | Sets the validation failure message template for a particular key | AbstractValidator |
| setMessageLength() | Sets the maximum allowed message length | AbstractValidator |
| setMessages() | 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. | AbstractValidator |
| setMin() | Sets the minimum file size | Size |
| setOptions() | Sets one or multiple options | AbstractValidator |
| setTranslator() | Set translation object | AbstractValidator |
| setTranslatorEnabled() | Indicate whether or not translation should be enabled | AbstractValidator |
| setTranslatorTextDomain() | Set translation text domain | AbstractValidator |
| setValueObscured() | Set flag indicating whether or not value should be obfuscated in messages | AbstractValidator |
| useByteString() | Should messages return bytes as integer or as string in SI notation | Size |
Sets validator 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'
| Parameter Name | Type | Description |
|---|---|---|
| $options | int|array|\Traversable | Options |
Returns:
Magic function returns the value of the requested property, if and only if it is the value or a message variable.
| Parameter Name | Type | Description |
|---|---|---|
| $property | string |
Returns: mixed
Invoke as command
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: bool
Will bytestring be used?
Returns: bool
Get default translation object for all validate objects
Returns: \Translator\TranslatorInterface|null
Get default translation text domain for all validate objects
Returns: string
Returns the maximum file size
| Parameter Name | Type | Description |
|---|---|---|
| $raw | bool | Whether |
Returns: int|string
Returns the maximum allowed message length
Returns: int
Returns the message templates from the validator
Returns: array
Returns an array of the names of variables that are used in constructing validation failure messages
Returns: array
Returns array of validation failure messages
Returns: array
Returns the minimum file size
| Parameter Name | Type | Description |
|---|---|---|
| $raw | bool | Whether |
Returns: int|string
Returns an option
| Parameter Name | Type | Description |
|---|---|---|
| $option | string | Option |
Returns: mixed Returned option
Returns all available options
Returns: array Array with all available options
Return translation object
Returns: \Translator\TranslatorInterface|null
Return the translation text domain
Returns: string
Is there a default translation object set?
Returns: bool
Does this validator have its own specific translator?
Returns: bool
Is translation enabled?
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).
| Parameter Name | Type | Description |
|---|---|---|
| $value | string|array | Real |
| $file | array | File |
Returns: bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Returns: bool
Set default translation object for all validate objects
| Parameter Name | Type | Description |
|---|---|---|
| $translator | \Translator\TranslatorInterface|null | |
| $textDomain | string | (optional) |
Returns: void
Set default translation text domain for all validate objects
| Parameter Name | Type | Description |
|---|---|---|
| $textDomain | string |
Returns: void
Sets the maximum file size
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
| Parameter Name | Type | Description |
|---|---|---|
| $max | int|string | The |
Returns: $this Provides a fluent interface
Sets the validation failure message template for a particular key
| Parameter Name | Type | Description |
|---|---|---|
| $messageString | string | |
| $messageKey | string | OPTIONAL |
Returns: $this Provides a fluent interface
Sets the maximum allowed message length
| Parameter Name | Type | Description |
|---|---|---|
| $length | int |
Returns:
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.
| Parameter Name | Type | Description |
|---|---|---|
| $messages | array |
Returns: $this
Sets the minimum file size
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
| Parameter Name | Type | Description |
|---|---|---|
| $min | int|string | The |
Returns: $this Provides a fluent interface
Sets one or multiple options
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable | Options |
Returns: $this Provides fluid interface
Set translation object
| Parameter Name | Type | Description |
|---|---|---|
| $translator | \Translator\TranslatorInterface|null | |
| $textDomain | string | (optional) |
Returns: $this
Indicate whether or not translation should be enabled
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: $this
Set translation text domain
| Parameter Name | Type | Description |
|---|---|---|
| $textDomain | string |
Returns: $this
Set flag indicating whether or not value should be obfuscated in messages
| Parameter Name | Type | Description |
|---|---|---|
| $flag | bool |
Returns: $this
Should messages return bytes as integer or as string in SI notation
| Parameter Name | Type | Description |
|---|---|---|
| $byteString | bool | Use |
Returns: int