Inheritance diagram for Zend_Validate_File_MimeType:

Public Member Functions
	__construct ($mimetype)

	getMagicFile ()

	setMagicFile ($file)

	setTryCommonMagicFilesFlag ($flag=true)

	shouldTryCommonMagicFiles ()

	getHeaderCheck ()

	enableHeaderCheck ($headerCheck=true)

	getMimeType ($asArray=false)

	setMimeType ($mimetype)

	addMimeType ($mimetype)

	isValid ($value, $file=null)

Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()

	getMessageVariables ()

	getMessageTemplates ()

	setMessage ($messageString, $messageKey=null)

	setMessages (array $messages)

	__get ($property)

	getErrors ()

	setObscureValue ($flag)

	getObscureValue ()

	setTranslator ($translator=null)

	getTranslator ()

	hasTranslator ()

	setDisableTranslator ($flag)

	translatorIsDisabled ()

Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)

Data Fields
const	FALSE_TYPE = 'fileMimeTypeFalse'

const	NOT_DETECTED = 'fileMimeTypeNotDetected'

const	NOT_READABLE = 'fileMimeTypeNotReadable'

Protected Member Functions
	_throw ($file, $errorType)

	_detectMimeType ($file)

	_errorHandler ($errno, $errstr, $errfile, $errline)

Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)

	_implodeRecursive (array $pieces)

	_error ($messageKey, $value=null)

	_setValue ($value)

Protected Attributes
	$_messageTemplates

	$_messageVariables

	$_type

	$_mimetype

	$_magicfile

	$_finfo

	$_magicFiles

	$_tryCommonMagicFiles = true

	$_headerCheck = false

	$_finfoError

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)

static	getDefaultTranslator ()

static	hasDefaultTranslator ()

static	getMessageLength ()

static	setMessageLength ($length=-1)

Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator

static	$_messageLength = -1

Detailed Description

Definition at line 35 of file MimeType.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $mimetype )

Sets validator options

Mimetype to accept

Parameters

string | array $mimetype MimeType

Exceptions

Zend_Validate_Exception

Definition at line 132 of file MimeType.php.

     {
         if ($mimetype instanceof Zend_Config) {
             $mimetype = $mimetype->toArray();
         } elseif (is_string($mimetype)) {
             $mimetype = explode(',', $mimetype);
         } elseif (!is_array($mimetype)) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception("Invalid options to validator provided");
         }
 
         if (isset($mimetype['magicfile'])) {
             $this->setMagicFile($mimetype['magicfile']);
             unset($mimetype['magicfile']);
         }
 
         if (isset($mimetype['headerCheck'])) {
             $this->enableHeaderCheck($mimetype['headerCheck']);
             unset($mimetype['headerCheck']);
         }
 
         $this->setMimeType($mimetype);
     }

Member Function Documentation

◆ _detectMimeType()

_detectMimeType ( $file )

protected

Try to detect mime type of given file.

Parameters

string $file File which mime type should be detected

Returns: string File mime type or null if not detected

Definition at line 431 of file MimeType.php.

     {
         $mimefile = $this->getMagicFile();
         $type = null;
 
         if (class_exists('finfo', false)) {
             $const = defined('FILEINFO_MIME_TYPE') ? FILEINFO_MIME_TYPE : FILEINFO_MIME;
 
             if (!empty($mimefile) && empty($this->_finfo)) {
                 set_error_handler(array($this, '_errorHandler'), E_NOTICE | E_WARNING);
                 $this->_finfo = finfo_open($const, $mimefile);
                 restore_error_handler();
             }
 
             if (empty($this->_finfo)) {
                 set_error_handler(array($this, '_errorHandler'), E_NOTICE | E_WARNING);
                 $this->_finfo = finfo_open($const);
                 restore_error_handler();
             }
 
             if (!empty($this->_finfo)) {
                 $type = finfo_file($this->_finfo, $file);
             }
         }
 
         if (empty($type) &&
             (function_exists('mime_content_type') && ini_get('mime_magic.magicfile'))) {
                 $type = mime_content_type($file);
         }
 
         return $type;
     }

◆ _errorHandler()

_errorHandler	(	$errno,
		$errstr,
		$errfile,
		$errline
	)

protected

Saves the provided error information by finfo_open to this instance

Parameters

integer	$errno
string	$errstr
string	$errfile
integer	$errline

Definition at line 472 of file MimeType.php.

     {
         $this->_finfoError = new ErrorException($errstr, $errno, 0, $errfile, $errline);
     }

◆ _throw()

_throw	(	$file,
		$errorType
	)

protected

Throws an error of the given type

Parameters

string	$file
string	$errorType

Returns: false

Definition at line 419 of file MimeType.php.

     {
         $this->_value = $file['name'];
         $this->_error($errorType);
         return false;
     }

◆ addMimeType()

addMimeType ( $mimetype )

Adds the mimetypes

Parameters

string | array $mimetype The mimetypes to add for validation

Exceptions

Zend_Validate_Exception

Returns: Zend_Validate_File_Extension Provides a fluent interface

Definition at line 324 of file MimeType.php.

     {
         $mimetypes = $this->getMimeType(true);
 
         if (is_string($mimetype)) {
             $mimetype = explode(',', $mimetype);
         } elseif (!is_array($mimetype)) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception("Invalid options to validator provided");
         }
 
         if (isset($mimetype['magicfile'])) {
             unset($mimetype['magicfile']);
         }
 
         foreach ($mimetype as $content) {
             if (empty($content) || !is_string($content)) {
                 continue;
             }
             $mimetypes[] = trim($content);
         }
         $mimetypes = array_unique($mimetypes);
 
         // Sanity check to ensure no empty values
         foreach ($mimetypes as $key => $mt) {
             if (empty($mt)) {
                 unset($mimetypes[$key]);
             }
         }
 
         $this->_mimetype = implode(',', $mimetypes);
 
         return $this;
     }

◆ enableHeaderCheck()

enableHeaderCheck ( $headerCheck = true )

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

Parameters

boolean $headerCheck

Returns: Zend_Validate_File_MimeType Provides a fluent interface

Definition at line 281 of file MimeType.php.

     {
         $this->_headerCheck = (boolean) $headerCheck;
         return $this;
     }

◆ getHeaderCheck()

getHeaderCheck ( )

Returns the Header Check option

Returns: boolean

Definition at line 269 of file MimeType.php.

     {
         return $this->_headerCheck;
     }

◆ getMagicFile()

getMagicFile ( )

Returns the actual set magicfile

Note that for PHP 5.3.0 or higher, we don't use $_ENV['MAGIC'] or try to find a magic file in a common location as PHP now has a built-in internal magic file.

Returns: string

Definition at line 165 of file MimeType.php.

     {
         if (version_compare(PHP_VERSION, '5.3.0', '<')
             && null === $this->_magicfile) {
             if (!empty($_ENV['MAGIC'])) {
                 $this->setMagicFile($_ENV['MAGIC']);
             } elseif (
                 !(@ini_get("safe_mode") == 'On' || @ini_get("safe_mode") === 1)
                 && $this->shouldTryCommonMagicFiles() // @see ZF-11784
             ) {
                 #require_once 'Zend/Validate/Exception.php';
                 foreach ($this->_magicFiles as $file) {
                     // supressing errors which are thrown due to openbase_dir restrictions
                     try {
                         $this->setMagicFile($file);
                         if ($this->_magicfile !== null) {
                             break;
                         }
                     } catch (Zend_Validate_Exception $e) {
                         // Intentionally, catch and fall through
                     }
                 }
             }
 
             if ($this->_magicfile === null) {
                 $this->_magicfile = false;
             }
         }
 
         return $this->_magicfile;
     }

◆ getMimeType()

getMimeType ( $asArray = false )

Returns the set mimetypes

Parameters

boolean $asArray Returns the values as array, when false an concated string is returned

Returns: string|array

Definition at line 293 of file MimeType.php.

     {
         $asArray   = (bool) $asArray;
         $mimetype = (string) $this->_mimetype;
         if ($asArray) {
             $mimetype = explode(',', $mimetype);
         }
 
         return $mimetype;
     }

◆ isValid()

isValid	(	$value,
		$file = `null`
	)

Defined by Zend_Validate_Interface

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

Parameters

string	$value	Real file to check for mimetype
array	$file	File data from Zend_File_Transfer

Returns: boolean

Definition at line 370 of file MimeType.php.

     {
         if ($file === null) {
             $file = array(
                 'type' => null,
                 'name' => $value
             );
         }
 
         // Is file readable ?
         #require_once 'Zend/Loader.php';
         if (!Zend_Loader::isReadable($value)) {
             return $this->_throw($file, self::NOT_READABLE);
         }
 
         $this->_type = $this->_detectMimeType($value);
 
         if (empty($this->_type) && $this->_headerCheck) {
             $this->_type = $file['type'];
         }
 
         if (empty($this->_type)) {
             return $this->_throw($file, self::NOT_DETECTED);
         }
 
         $mimetype = $this->getMimeType(true);
         if (in_array($this->_type, $mimetype)) {
             return true;
         }
 
         $types = explode('/', $this->_type);
         $types = array_merge($types, explode('-', $this->_type));
         $types = array_merge($types, explode(';', $this->_type));
         foreach($mimetype as $mime) {
             if (in_array($mime, $types)) {
                 return true;
             }
         }
 
         return $this->_throw($file, self::FALSE_TYPE);
     }

◆ setMagicFile()

setMagicFile ( $file )

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

Parameters

string $file

Exceptions

Zend_Validate_Exception When finfo can not read the magicfile

Returns: Zend_Validate_File_MimeType Provides a fluent interface

Definition at line 206 of file MimeType.php.

     {
         if (empty($file)) {
             $this->_magicfile = null;
         } else if (!(class_exists('finfo', false))) {
             $this->_magicfile = null;
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('Magicfile can not be set. There is no finfo extension installed');
         } else if (!is_file($file) || !is_readable($file)) {
             #require_once 'Zend/Validate/Exception.php';
             throw new Zend_Validate_Exception('The given magicfile can not be read');
         } else {
             $const = defined('FILEINFO_MIME_TYPE') ? FILEINFO_MIME_TYPE : FILEINFO_MIME;
             set_error_handler(array($this, '_errorHandler'), E_NOTICE | E_WARNING);
             $this->_finfo = finfo_open($const, $file);
             restore_error_handler();
             if (empty($this->_finfo)) {
                 $this->_finfo = null;
                 #require_once 'Zend/Validate/Exception.php';
                 throw new Zend_Validate_Exception(
                     sprintf('The given magicfile ("%s") is not accepted by finfo', $file),
                     null,
                     $this->_finfoError
                 );
             } else {
                 $this->_magicfile = $file;
             }
         }
 
         return $this;
     }

◆ setMimeType()

setMimeType ( $mimetype )

Sets the mimetypes

Parameters

string | array $mimetype The mimetypes to validate

Returns: Zend_Validate_File_Extension Provides a fluent interface

Definition at line 310 of file MimeType.php.

     {
         $this->_mimetype = null;
         $this->addMimeType($mimetype);
         return $this;
     }

◆ setTryCommonMagicFilesFlag()

setTryCommonMagicFilesFlag ( $flag = true )

Enables or disables attempts to try the common magic file locations specified by Zend_Validate_File_MimeType::_magicFiles

Parameters

boolean $flag

Returns: Zend_Validate_File_MimeType Provides fluent interface

See also: http://framework.zend.com/issues/browse/ZF-11784

Definition at line 246 of file MimeType.php.

     {
         $this->_tryCommonMagicFiles = (boolean) $flag;
 
         return $this;
     }

◆ shouldTryCommonMagicFiles()

shouldTryCommonMagicFiles ( )

Accessor for Zend_Validate_File_MimeType::_magicFiles

Returns: boolean

See also: http://framework.zend.com/issues/browse/ZF-11784

Definition at line 259 of file MimeType.php.

     {
         return $this->_tryCommonMagicFiles;
     }

Field Documentation

◆ $_finfo

$_finfo

protected

Definition at line 86 of file MimeType.php.

◆ $_finfoError

$_finfoError

protected

Definition at line 122 of file MimeType.php.

◆ $_headerCheck

$_headerCheck = false

protected

Definition at line 115 of file MimeType.php.

◆ $_magicfile

$_magicfile

protected

Definition at line 79 of file MimeType.php.

◆ $_magicFiles

$_magicFiles

protected

Initial value:

= array(
        '/usr/share/misc/magic',
        '/usr/share/misc/magic.mime',
        '/usr/share/misc/magic.mgc',
        '/usr/share/mime/magic',
        '/usr/share/mime/magic.mime',
        '/usr/share/mime/magic.mgc',
        '/usr/share/file/magic',
        '/usr/share/file/magic.mime',
        '/usr/share/file/magic.mgc',
    )

Definition at line 92 of file MimeType.php.

◆ $_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::FALSE_TYPE   => "File '%value%' has a false mimetype of '%type%'",
        self::NOT_DETECTED => "The mimetype of file '%value%' could not be detected",
        self::NOT_READABLE => "File '%value%' is not readable or does not exist",
    )

Definition at line 47 of file MimeType.php.

◆ $_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'type' => '_type'
    )

Definition at line 56 of file MimeType.php.

◆ $_mimetype

$_mimetype

protected

Definition at line 72 of file MimeType.php.

◆ $_tryCommonMagicFiles

$_tryCommonMagicFiles = true

protected

Definition at line 108 of file MimeType.php.

◆ $_type

$_type

protected

Definition at line 63 of file MimeType.php.

◆ FALSE_TYPE

const FALSE_TYPE = 'fileMimeTypeFalse'

@const Error type constants

Definition at line 40 of file MimeType.php.

◆ NOT_DETECTED

const NOT_DETECTED = 'fileMimeTypeNotDetected'

Definition at line 41 of file MimeType.php.

◆ NOT_READABLE

const NOT_READABLE = 'fileMimeTypeNotReadable'

Definition at line 42 of file MimeType.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Validate/File/MimeType.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _detectMimeType()

◆ _errorHandler()

◆ _throw()

◆ addMimeType()

◆ enableHeaderCheck()

◆ getHeaderCheck()

◆ getMagicFile()

◆ getMimeType()

◆ isValid()

◆ setMagicFile()

◆ setMimeType()

◆ setTryCommonMagicFilesFlag()

◆ shouldTryCommonMagicFiles()

Field Documentation

◆ $_finfo

◆ $_finfoError

◆ $_headerCheck

◆ $_magicfile

◆ $_magicFiles

◆ $_messageTemplates

◆ $_messageVariables

◆ $_mimetype

◆ $_tryCommonMagicFiles

◆ $_type

◆ FALSE_TYPE

◆ NOT_DETECTED

◆ NOT_READABLE