Zend_Validate_File_Upload Class Reference

Public Member Functions
	__construct ($files=array())
	Sets validator options.
	getFiles ($file=null)
	Returns the array of set files.
	setFiles ($files=array())
	Sets the files to be checked.
	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	INI_SIZE = 'fileUploadErrorIniSize'
	#+ string Error constants
const	FORM_SIZE = 'fileUploadErrorFormSize'
const	PARTIAL = 'fileUploadErrorPartial'
const	NO_FILE = 'fileUploadErrorNoFile'
const	NO_TMP_DIR = 'fileUploadErrorNoTmpDir'
const	CANT_WRITE = 'fileUploadErrorCantWrite'
const	EXTENSION = 'fileUploadErrorExtension'
const	ATTACK = 'fileUploadErrorAttack'
const	FILE_NOT_FOUND = 'fileUploadErrorFileNotFound'
const	UNKNOWN = 'fileUploadErrorUnknown'

Protected Member Functions
	_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
	$_files = array()
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

(

$files = array()

)

Sets validator options.

The array $files must be given in syntax of Zend_File_Transfer to be checked If no files are given the $_FILES array will be used automatically. NOTE: This validator will only work with HTTP POST uploads!

Parameters

array | Zend_Config

$files

Array of files in syntax of Zend_File_Transfer

Returns

void

Member Function Documentation

_throw (   $file,   $errorType  )

protected

Throws an error of the given type.

Parameters

string	$file
string	$errorType

Returns

false

getFiles

(

$file = null

)

Returns the array of set files.

Parameters

string

$files

(Optional) The file to return in detail

Returns

array

Exceptions

Zend_Validate_Exception

If file is not found

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface.

Returns true if and only if the file was uploaded without errors

Parameters

string

$value

Single file to check for upload errors, when giving null the $_FILES array from initialization will be used

Returns

boolean

setFiles

(

$files = array()

)

Sets the files to be checked.

Parameters

array

$files

The files to check in syntax of Zend_File_Transfer

Returns

Zend_Validate_File_Upload Provides a fluent interface

Member Data Documentation

$_files = array()

protected

$_messageTemplates

protected

Initial value:

= array(
        self::INI_SIZE       => "File '%value%' exceeds the defined ini size",
        self::FORM_SIZE      => "File '%value%' exceeds the defined form size",
        self::PARTIAL        => "File '%value%' was only partially uploaded",
        self::NO_FILE        => "File '%value%' was not uploaded",
        self::NO_TMP_DIR     => "No temporary directory was found for file '%value%'",
        self::CANT_WRITE     => "File '%value%' can't be written",
        self::EXTENSION      => "A PHP extension returned an error while uploading the file '%value%'",
        self::ATTACK         => "File '%value%' was illegally uploaded. This could be a possible attack",
        self::FILE_NOT_FOUND => "File '%value%' was not found",
        self::UNKNOWN        => "Unknown error while uploading file '%value%'"
    )

const ATTACK = 'fileUploadErrorAttack'

const CANT_WRITE = 'fileUploadErrorCantWrite'

const EXTENSION = 'fileUploadErrorExtension'

const FILE_NOT_FOUND = 'fileUploadErrorFileNotFound'

const FORM_SIZE = 'fileUploadErrorFormSize'

const INI_SIZE = 'fileUploadErrorIniSize'

#+ string Error constants

const NO_FILE = 'fileUploadErrorNoFile'

const NO_TMP_DIR = 'fileUploadErrorNoTmpDir'

const PARTIAL = 'fileUploadErrorPartial'

const UNKNOWN = 'fileUploadErrorUnknown'