Validate/File/Upload.php

Show:

inherited

Classes
- \Zend_Validate_File_Upload

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 [email protected] 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: Upload.php 24959 2012-06-15 13:51:04Z adamlundrigan $

\Zend_Validate_File_Upload
jump to top

Package: Zend\Validate

Validator for the maximum size of a file up to a max of 2GB

Parent(s): \Zend_Validate_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                INI_SIZE
                = 'fileUploadErrorIniSize'

 
                FORM_SIZE
                = 'fileUploadErrorFormSize'

 
                PARTIAL
                = 'fileUploadErrorPartial'

 
                NO_FILE
                = 'fileUploadErrorNoFile'

 
                NO_TMP_DIR
                = 'fileUploadErrorNoTmpDir'

 
                CANT_WRITE
                = 'fileUploadErrorCantWrite'

 
                EXTENSION
                = 'fileUploadErrorExtension'

 
                ATTACK
                = 'fileUploadErrorAttack'

 
                FILE_NOT_FOUND
                = 'fileUploadErrorFileNotFound'

 
                UNKNOWN
                = 'fileUploadErrorUnknown'

Properties

\Zend_Translate $_defaultTranslator =

staticinherited

Default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::$$_defaultTranslator

Details

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

array $_errors = array()

inherited

Array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::$$_errors

Default valuearray()Details

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

array $_files = array()

Internal array of files

Default valuearray()Details

Type: array

Integer $_messageLength = -1

staticinherited

Limits the maximum returned length of a error message

Inherited from: \Zend_Validate_Abstract::$$_messageLength

Default value-1Details

Type: Integer
Inherited_from: \Zend_Validate_Abstract::$$_messageLength

array $_messageTemplates = 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%'")

<p>Error message templates</p>

Validation failure message template definitions

Default 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%'")

Details

Type: array

array $_messageVariables = array()

inherited

Additional variables available for validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messageVariables

Default valuearray()Details

Type: array
Inherited_from: \Zend_Validate_Abstract::$$_messageVariables

array $_messages = array()

inherited

Array of validation failure messages

Inherited from: \Zend_Validate_Abstract::$$_messages

Default valuearray()Details

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

bool $_obscureValue = false

inherited

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

Inherited from: \Zend_Validate_Abstract::$$_obscureValue

Default valuefalseDetails

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

\Zend_Translate $_translator =

inherited

Translation object

Inherited from: \Zend_Validate_Abstract::$$_translator

Details

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

Boolean $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::$$_translatorDisabled

Default valuefalseDetails

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

mixed $_value =

inherited

The value to be validated

Inherited from: \Zend_Validate_Abstract::$$_value

Details

Type: mixed
Inherited_from: \Zend_Validate_Abstract::$$_value

Methods

__construct(array | \Zend_Config $files = array()) : void

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

Name	Type	Description
$files	array \| \Zend_Config	Array of files in syntax of Zend_File_Transfer

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

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

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

Parameters

Name	Type	Description
$messageKey	string
$value	string	OPTIONAL

_setValue(mixed $value) : void

inherited

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

Inherited from: \Zend_Validate_Abstract::_setValue()

Parameters

Name	Type	Description
$value	mixed

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

Throws an error of the given type

Parameters

Name	Type	Description
$file	string
$errorType	string

Returns

Type	Description
false

getDefaultTranslator() : \Zend_Translate_Adapter | null

staticinherited

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getErrors() : array

inherited

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()

Returns

Type	Description
array

getFiles( $file = null) : array

Returns the array of set files

Parameters

Name	Type	Description
$file

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Validate_Exception	If file is not found

getMessageLength() : integer

staticinherited

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()

Returns

Type	Description
integer

getMessageTemplates() : array

inherited

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::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()

Returns

Type	Description
array

getMessages() : array

inherited

Returns array of validation failure messages

Inherited from: \Zend_Validate_Abstract::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

getObscureValue() : bool

inherited

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

Inherited from: \Zend_Validate_Abstract::getObscureValue()

Returns

Type	Description
bool

getTranslator() : \Zend_Translate_Adapter | null

inherited

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

hasDefaultTranslator() : boolean

staticinherited

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()

Returns

Type	Description
boolean

hasTranslator() : bool

inherited

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()

Returns

Type	Description
bool

isValid(string $value, $file = null) : boolean

Defined by Zend_Validate_Interface

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

Parameters

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

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

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

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Validate_Abstract

setFiles(array $files = array()) : \Zend_Validate_File_Upload

Sets the files to be checked

Parameters

Name	Type	Description
$files	array	The files to check in syntax of Zend_File_Transfer

Returns

Type	Description
\Zend_Validate_File_Upload	Provides a fluent interface

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

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

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

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Validate_Abstract

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

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

Parameters

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

Returns

Type	Description
\Zend_Validate_Abstract

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()

Returns

Type	Description
bool

Validate/File/Upload.php

\Zend_Validate_File_Uploadjump to top

Constants

Properties

Methods

\Zend_Validate_File_Upload
jump to top