Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Validate_File_Size Class Reference

Public Member Functions

 __construct ($options)
 Sets validator options.
 
 setUseByteString ($byteString=true)
 Returns the minimum filesize.
 
 useByteString ()
 Will bytestring be used?
 
 getMin ($raw=false)
 Returns the minimum filesize.
 
 setMin ($min)
 Sets the minimum filesize.
 
 getMax ($raw=false)
 Returns the maximum filesize.
 
 setMax ($max)
 Sets the maximum filesize.
 
 isValid ($value, $file=null)
 Defined by Zend_Validate_Interface.
 
- Public Member Functions inherited from Zend_Validate_Abstract
 getMessages ()
 Returns array of validation failure messages.
 
 getMessageVariables ()
 Returns an array of the names of variables that are used in constructing validation failure messages.
 
 getMessageTemplates ()
 Returns the message templates from the validator.
 
 setMessage ($messageString, $messageKey=null)
 Sets the validation failure message template for a particular key.
 
 setMessages (array $messages)
 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.
 
 __get ($property)
 Magic function returns the value of the requested property, if and only if it is the value or a message variable.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

const TOO_BIG = 'fileSizeTooBig'
 #@+ string Error constants
 
const TOO_SMALL = 'fileSizeTooSmall'
 
const NOT_FOUND = 'fileSizeNotFound'
 

Protected Member Functions

 _getSize ()
 Retrieve current detected file size.
 
 _setSize ($size)
 Set current size.
 
 _toByteString ($size)
 Returns the formatted size.
 
 _fromByteString ($size)
 Returns the unformatted size.
 
 _throw ($file, $errorType)
 Throws an error of the given type.
 
- Protected Member Functions inherited from Zend_Validate_Abstract
 _createMessage ($messageKey, $value)
 Constructs and returns a validation failure message with the given message key and value.
 
 _error ($messageKey, $value=null)
 
 _setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 

Protected Attributes

 $_messageTemplates
 
 $_messageVariables
 
 $_min
 
 $_max
 
 $_size
 
 $_useByteString = true
 
- Protected Attributes inherited from Zend_Validate_Abstract
 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Validate_Abstract
static setDefaultTranslator ($translator=null)
 Set default translation object for all validate objects.
 
static getDefaultTranslator ()
 Get default translation object for all validate objects.
 
static hasDefaultTranslator ()
 Is there a default translation object set?
 
static getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Static Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Constructor & Destructor Documentation

__construct (   $options)

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
integer | array$optionsOptions for the adapter

Member Function Documentation

_fromByteString (   $size)
protected

Returns the unformatted size.

Parameters
string$size
Returns
integer
_getSize ( )
protected

Retrieve current detected file size.

Returns
int
_setSize (   $size)
protected

Set current size.

Parameters
int$size
Returns
Zend_Validate_File_Size
_throw (   $file,
  $errorType 
)
protected

Throws an error of the given type.

Parameters
string$file
string$errorType
Returns
false
_toByteString (   $size)
protected

Returns the formatted size.

Parameters
integer$size
Returns
string
getMax (   $raw = false)

Returns the maximum filesize.

Parameters
bool$rawWhether or not to force return of the raw value (defaults off)
Returns
integer|string
getMin (   $raw = false)

Returns the minimum filesize.

Parameters
bool$rawWhether or not to force return of the raw value (defaults off)
Returns
integer|string
isValid (   $value,
  $file = null 
)

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
string$valueReal file to check for size
array$fileFile data from Zend_File_Transfer
Returns
boolean
setMax (   $max)

Sets the maximum filesize.

Parameters
integer$maxThe maximum filesize
Exceptions
Zend_Validate_ExceptionWhen max is smaller than min
Returns
Zend_Validate_StringLength Provides a fluent interface
setMin (   $min)

Sets the minimum filesize.

Parameters
integer$minThe minimum filesize
Exceptions
Zend_Validate_ExceptionWhen min is greater than max
Returns
Zend_Validate_File_Size Provides a fluent interface
setUseByteString (   $byteString = true)

Returns the minimum filesize.

Parameters
boolean$byteStringUse bytestring ?
Returns
integer
useByteString ( )

Will bytestring be used?

Returns
boolean

Member Data Documentation

$_max
protected
$_messageTemplates
protected
Initial value:
= 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",
)
$_messageVariables
protected
Initial value:
= array(
'min' => '_min',
'max' => '_max',
'size' => '_size',
)
$_min
protected
$_size
protected
$_useByteString = true
protected
const NOT_FOUND = 'fileSizeNotFound'
const TOO_BIG = 'fileSizeTooBig'

#@+ string Error constants

const TOO_SMALL = 'fileSizeTooSmall'