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.
Validator for the mime type of a file

__construct(
string|array $mimetype
)
:
void
Sets validator options
Inherited from: \Zend_Validate_File_MimeType::__construct()Mimetype to accept
Name | Type | Description |
---|---|---|
$mimetype | string|array | MimeType |

__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()Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Validate_Exception |

_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.
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string |
Type | Description |
---|---|
string |

_error(
string $messageKey, string $value
=
null
)
:
void
Name | Type | Description |
---|---|---|
$messageKey | string | |
$value | string | OPTIONAL |

_setValue(
mixed $value
)
:
void
Sets the value to be validated and clears the messages and errors arrays
Inherited from: \Zend_Validate_Abstract::_setValue()Name | Type | Description |
---|---|---|
$value | mixed |

_throw(
string $file, string $errorType
)
:
false
Throws an error of the given type
Inherited from: \Zend_Validate_File_MimeType::_throw()Name | Type | Description |
---|---|---|
$file | string | |
$errorType | string |
Type | Description |
---|---|
false |

addMimeType(
string|array $mimetype
)
:
\Zend_Validate_File_Extension
Adds the mimetypes
Inherited from: \Zend_Validate_File_MimeType::addMimeType()Name | Type | Description |
---|---|---|
$mimetype | string|array | The mimetypes to add for validation |
Type | Description |
---|---|
\Zend_Validate_File_Extension | Provides a fluent interface |

enableHeaderCheck(
$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()Name | Type | Description |
---|---|---|
$headerCheck |
Type | Description |
---|---|
\Zend_Validate_File_MimeType | Provides fluid interface |

getDefaultTranslator(
)
:
\Zend_Translate_Adapter|null
Get default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::getDefaultTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getErrors(
)
:
array
Returns array of validation failure message codes
Inherited from: \Zend_Validate_Abstract::getErrors()Type | Description |
---|---|
array |

getHeaderCheck(
)
:
boolean
Returns the Header Check option
Inherited from: \Zend_Validate_File_MimeType::getHeaderCheck()Type | Description |
---|---|
boolean |

getMagicFile(
)
:
string
Returns the actual set magicfile
Inherited from: \Zend_Validate_File_MimeType::getMagicFile()Type | Description |
---|---|
string |

getMessageLength(
)
:
integer
Returns the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::getMessageLength()Type | Description |
---|---|
integer |

getMessageTemplates(
)
:
array
Returns the message templates from the validator
Inherited from: \Zend_Validate_Abstract::getMessageTemplates()Type | Description |
---|---|
array |

getMessageVariables(
)
:
array
Returns an array of the names of variables that are used in constructing validation failure messages
Inherited from: \Zend_Validate_Abstract::getMessageVariables()Type | Description |
---|---|
array |

getMessages(
)
:
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.
Type | Description |
---|---|
array |

getMimeType(
boolean $asArray
=
false
)
:
string|array
Returns the set mimetypes
Inherited from: \Zend_Validate_File_MimeType::getMimeType()Name | Type | Description |
---|---|---|
$asArray | boolean | Returns the values as array, when false an concated string is returned |
Type | Description |
---|---|
stringarray |

getObscureValue(
)
:
bool
Retrieve flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::getObscureValue()Type | Description |
---|---|
bool |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Return translation object
Inherited from: \Zend_Validate_Abstract::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

hasDefaultTranslator(
)
:
boolean
Is there a default translation object set?
Inherited from: \Zend_Validate_Abstract::hasDefaultTranslator()Type | Description |
---|---|
boolean |

hasTranslator(
)
:
bool
Does this validator have its own specific translator?
Inherited from: \Zend_Validate_Abstract::hasTranslator()Type | Description |
---|---|
bool |

isValid(
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.
Name | Type | Description |
---|---|---|
$value | string | Real file to check for mimetype |
$file | array | File data from Zend_File_Transfer |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Validate_Exception | If validation of $value is impossible |

setDefaultTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
void
Set default translation object for all validate objects
Inherited from: \Zend_Validate_Abstract::setDefaultTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |

setDisableTranslator(
bool $flag
)
:
\Zend_Validate_Abstract
Indicate whether or not translation should be disabled
Inherited from: \Zend_Validate_Abstract::setDisableTranslator()
setMagicFile(
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()Name | Type | Description |
---|---|---|
$file | string |
Type | Description |
---|---|
\Zend_Validate_File_MimeType | Provides fluid interface |
Exception | Description |
---|---|
\Zend_Validate_Exception | When finfo can not read the magicfile |

setMessage(
string $messageString, string $messageKey
=
null
)
:
\Zend_Validate_Abstract
Sets the validation failure message template for a particular key
Inherited from: \Zend_Validate_Abstract::setMessage()Name | Type | Description |
---|---|---|
$messageString | string | |
$messageKey | string | OPTIONAL |
Type | Description |
---|---|
\Zend_Validate_Abstract | Provides a fluent interface |
Exception | Description |
---|---|
\Zend_Validate_Exception |

setMessageLength(
integer $length
)
:
void
Sets the maximum allowed message length
Inherited from: \Zend_Validate_Abstract::setMessageLength()Name | Type | Description |
---|---|---|
$length | integer |

setMessages(
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()
setMimeType(
string|array $mimetype
)
:
\Zend_Validate_File_Extension
Sets the mimetypes
Inherited from: \Zend_Validate_File_MimeType::setMimeType()Name | Type | Description |
---|---|---|
$mimetype | string|array | The mimetypes to validate |
Type | Description |
---|---|
\Zend_Validate_File_Extension | Provides a fluent interface |

setObscureValue(
bool $flag
)
:
\Zend_Validate_Abstract
Set flag indicating whether or not value should be obfuscated in messages
Inherited from: \Zend_Validate_Abstract::setObscureValue()
setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
\Zend_Validate_Abstract
Set translation object
Inherited from: \Zend_Validate_Abstract::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Validate_Abstract |

translatorIsDisabled(
)
:
bool
Is translation disabled?
Inherited from: \Zend_Validate_Abstract::translatorIsDisabled()Type | Description |
---|---|
bool |