API Documentation

Validate/File/ExcludeMimeType.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  
version
$Id: ExcludeMimeType.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Validate_File_ExcludeMimeType

Validator for the mime type of a file

Extends from
\Zend_Validate_File_MimeType
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Validate  

Constants

Constant  FALSE_TYPE = 'fileExcludeMimeTypeFalse'
Constant  NOT_DETECTED = 'fileExcludeMimeTypeNotDetected'
Constant  NOT_READABLE = 'fileExcludeMimeTypeNotReadable'

Methods

methodpublic__construct( string|array $mimetype ) : void

Sets validator options

Inherited from: \Zend_Validate_File_MimeType::__construct()

Mimetype to accept

Parameters
Name Type Description
$mimetype string|array MimeType
methodpublic__get( string $property ) : mixed

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
methodprotected_createMessage( string $messageKey, string $value ) : string

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
methodprotected_error( string $messageKey, string $value = null ) : void
Parameters
Name Type Description
$messageKey string
$value string OPTIONAL
methodprotected_setValue( mixed $value ) : void

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
methodprotected_throw( string $file, string $errorType ) : false

Throws an error of the given type

Inherited from: \Zend_Validate_File_MimeType::_throw()
Parameters
Name Type Description
$file string
$errorType string
Returns
Type Description
false
methodpublicaddMimeType( string|array $mimetype ) : \Zend_Validate_File_Extension

Adds the mimetypes

Inherited from: \Zend_Validate_File_MimeType::addMimeType()
Parameters
Name Type Description
$mimetype string|array The mimetypes to add for validation
Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
methodpublicenableHeaderCheck(  $headerCheck = true ) : \Zend_Validate_File_MimeType

Defines if the http header should be used Note that this is unsave and therefor the default value is false

Inherited from: \Zend_Validate_File_MimeType::enableHeaderCheck()
Parameters
Name Type Description
$headerCheck
Returns
Type Description
\Zend_Validate_File_MimeType Provides fluid interface
methodpublicgetDefaultTranslator( ) : \Zend_Translate_Adapter|null
static

Get default translation object for all validate objects

Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetErrors( ) : array

Returns array of validation failure message codes

Inherited from: \Zend_Validate_Abstract::getErrors()
Returns
Type Description
array
Details
deprecated
Since 1.5.0  
methodpublicgetHeaderCheck( ) : boolean

Returns the Header Check option

Inherited from: \Zend_Validate_File_MimeType::getHeaderCheck()
Returns
Type Description
boolean
methodpublicgetMagicFile( ) : string

Returns the actual set magicfile

Inherited from: \Zend_Validate_File_MimeType::getMagicFile()
Returns
Type Description
string
methodpublicgetMessageLength( ) : integer
static

Returns the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::getMessageLength()
Returns
Type Description
integer
methodpublicgetMessageTemplates( ) : array

Returns the message templates from the validator

Inherited from: \Zend_Validate_Abstract::getMessageTemplates()
Returns
Type Description
array
methodpublicgetMessageVariables( ) : array

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
methodpublicgetMessages( ) : array

Returns array of validation failure messages

Inherited from: \Zend_Validate_Abstract::getMessages()

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
methodpublicgetMimeType( boolean $asArray = false ) : string|array

Returns the set mimetypes

Inherited from: \Zend_Validate_File_MimeType::getMimeType()
Parameters
Name Type Description
$asArray boolean Returns the values as array, when false an concated string is returned
Returns
Type Description
stringarray
methodpublicgetObscureValue( ) : bool

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

Inherited from: \Zend_Validate_Abstract::getObscureValue()
Returns
Type Description
bool
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Return translation object

Inherited from: \Zend_Validate_Abstract::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublichasDefaultTranslator( ) : boolean
static

Is there a default translation object set?

Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()
Returns
Type Description
boolean
methodpublichasTranslator( ) : bool

Does this validator have its own specific translator?

Inherited from: \Zend_Validate_Abstract::hasTranslator()
Returns
Type Description
bool
methodpublicisValid( string $value, array $file = null ) : boolean

Defined by Zend_Validate_Interface

Returns true if the mimetype of the file does not matche the given ones. Also parts of mimetypes can be checked. If you give for example "image" all image mime types will not be accepted like "image/gif", "image/jpeg" and so on.

Parameters
Name Type Description
$value string Real file to check for mimetype
$file array File data from Zend_File_Transfer
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Validate_Exception If validation of $value is impossible
methodpublicsetDefaultTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : void
static

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
methodpublicsetDisableTranslator( bool $flag ) : \Zend_Validate_Abstract

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
methodpublicsetMagicFile( string $file ) : \Zend_Validate_File_MimeType

Sets the magicfile to use if null, the MAGIC constant from php is used if the MAGIC file is errorous, no file will be set

Inherited from: \Zend_Validate_File_MimeType::setMagicFile()
Parameters
Name Type Description
$file string
Returns
Type Description
\Zend_Validate_File_MimeType Provides fluid interface
Throws
Exception Description
\Zend_Validate_Exception When finfo can not read the magicfile
methodpublicsetMessage( string $messageString, string $messageKey = null ) : \Zend_Validate_Abstract

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
methodpublicsetMessageLength( integer $length ) : void
static

Sets the maximum allowed message length

Inherited from: \Zend_Validate_Abstract::setMessageLength()
Parameters
Name Type Description
$length integer
methodpublicsetMessages( array $messages ) : \Zend_Validate_Abstract

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
methodpublicsetMimeType( string|array $mimetype ) : \Zend_Validate_File_Extension

Sets the mimetypes

Inherited from: \Zend_Validate_File_MimeType::setMimeType()
Parameters
Name Type Description
$mimetype string|array The mimetypes to validate
Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
methodpublicsetObscureValue( bool $flag ) : \Zend_Validate_Abstract

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
methodpublicsetTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Validate_Abstract

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
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()
Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.