Class IsImage

Summary

Fully Qualified Name: Zend\Validator\File\IsImage
Extends: MimeType

Description

Validator which checks if the file is an image

Methods

Name Description Defined By
__construct() Sets validator options IsImage
__get() Magic function returns the value of the requested property, if and only if it is the value or a message variable. AbstractValidator
__invoke() Invoke as command AbstractValidator
addMimeType() Adds the mimetypes MimeType
disableMagicFile() Disables usage of MagicFile MimeType
enableHeaderCheck() Defines if the http header should be used Note that this is unsafe and therefor the default value is false MimeType
getDefaultTranslator() Get default translation object for all validate objects AbstractValidator
getDefaultTranslatorTextDomain() Get default translation text domain for all validate objects AbstractValidator
getHeaderCheck() Returns the Header Check option MimeType
getMagicFile() Returns the actual set magicfile MimeType
getMessageLength() Returns the maximum allowed message length AbstractValidator
getMessageTemplates() Returns the message templates from the validator AbstractValidator
getMessageVariables() Returns an array of the names of variables that are used in constructing validation failure messages AbstractValidator
getMessages() Returns array of validation failure messages AbstractValidator
getMimeType() Returns the set mimetypes MimeType
getOption() Returns an option AbstractValidator
getOptions() Returns all available options AbstractValidator
getTranslator() Return translation object AbstractValidator
getTranslatorTextDomain() Return the translation text domain AbstractValidator
hasDefaultTranslator() Is there a default translation object set? AbstractValidator
hasTranslator() Does this validator have its own specific translator? AbstractValidator
isMagicFileDisabled() Is usage of MagicFile disabled? MimeType
isTranslatorEnabled() Is translation enabled? AbstractValidator
isValid() Defined by Zend\Validator\ValidatorInterface MimeType
isValueObscured() Retrieve flag indicating whether or not value should be obfuscated in messages AbstractValidator
setDefaultTranslator() Set default translation object for all validate objects AbstractValidator
setDefaultTranslatorTextDomain() Set default translation text domain for all validate objects AbstractValidator
setMagicFile() Sets the magicfile to use if null, the MAGIC constant from php is used if the MAGIC file is erroneous, no file will be set if false, the default MAGIC file from PHP will be used MimeType
setMessage() Sets the validation failure message template for a particular key AbstractValidator
setMessageLength() Sets the maximum allowed message length AbstractValidator
setMessages() 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. AbstractValidator
setMimeType() Sets the mimetypes MimeType
setOptions() Sets one or multiple options AbstractValidator
setTranslator() Set translation object AbstractValidator
setTranslatorEnabled() Indicate whether or not translation should be enabled AbstractValidator
setTranslatorTextDomain() Set translation text domain AbstractValidator
setValueObscured() Set flag indicating whether or not value should be obfuscated in messages AbstractValidator

Method Details

__construct()

Sets validator options

Parameter Name Type Description
$options array|\Traversable|string

Returns:

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Parameter Name Type Description
$property string

Returns: mixed

__invoke()

Invoke as command

Parameter Name Type Description
$value mixed

Returns: bool

addMimeType()

Adds the mimetypes

Parameter Name Type Description
$mimetype string|array The

Returns: self Provides a fluent interface

disableMagicFile()

Disables usage of MagicFile

Parameter Name Type Description
boolean $disable False
$disable

Returns: self Provides fluid interface

enableHeaderCheck()

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

Parameter Name Type Description
$headerCheck bool

Returns: self Provides fluid interface

getDefaultTranslator()

Get default translation object for all validate objects

Returns: \Translator\TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects

Returns: string

getHeaderCheck()

Returns the Header Check option

Returns: bool

getMagicFile()

Returns the actual set magicfile

Returns: string

getMessageLength()

Returns the maximum allowed message length

Returns: int

getMessageTemplates()

Returns the message templates from the validator

Returns: array

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages

Returns: array

getMessages()

Returns array of validation failure messages

Returns: array

getMimeType()

Returns the set mimetypes

Parameter Name Type Description
$asArray bool Returns

Returns: string|array

getOption()

Returns an option

Parameter Name Type Description
$option string Option

Returns: mixed Returned option

getOptions()

Returns all available options

Returns: array Array with all available options

getTranslator()

Return translation object

Returns: \Translator\TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

hasDefaultTranslator()

Is there a default translation object set?

Returns: bool

hasTranslator()

Does this validator have its own specific translator?

Returns: bool

isMagicFileDisabled()

Is usage of MagicFile disabled?

Returns: bool

isTranslatorEnabled()

Is translation enabled?

Returns: bool

isValid()

Defined by Zend\Validator\ValidatorInterface

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.

Parameter Name Type Description
$value string|array Real
$file array File

Returns: bool

isValueObscured()

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

Returns: bool

setDefaultTranslator()

Set default translation object for all validate objects

Parameter Name Type Description
$translator \Translator\TranslatorInterface|null
$textDomain string (optional)

Returns: void

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects

Parameter Name Type Description
$textDomain string

Returns: void

setMagicFile()

Sets the magicfile to use if null, the MAGIC constant from php is used if the MAGIC file is erroneous, no file will be set if false, the default MAGIC file from PHP will be used

Parameter Name Type Description
$file string

Returns: self Provides fluid interface

setMessage()

Sets the validation failure message template for a particular key

Parameter Name Type Description
$messageString string
$messageKey string OPTIONAL

Returns: \AbstractValidator Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length

Parameter Name Type Description
$length int

Returns:

setMessages()

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.

Parameter Name Type Description
$messages array

Returns: \AbstractValidator

setMimeType()

Sets the mimetypes

Parameter Name Type Description
$mimetype string|array The

Returns: self Provides a fluent interface

setOptions()

Sets one or multiple options

Parameter Name Type Description
$options array|\Traversable Options

Returns: \AbstractValidator Provides fluid interface

setTranslator()

Set translation object

Parameter Name Type Description
$translator \Translator\TranslatorInterface|null
$textDomain string (optional)

Returns: \AbstractValidator

setTranslatorEnabled()

Indicate whether or not translation should be enabled

Parameter Name Type Description
$flag bool

Returns: \AbstractValidator

setTranslatorTextDomain()

Set translation text domain

Parameter Name Type Description
$textDomain string

Returns: \AbstractValidator

setValueObscured()

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

Parameter Name Type Description
$flag bool

Returns: \AbstractValidator

Top