Class Sha1

Summary

Fully Qualified Name: Zend\Validator\File\Sha1
Extends: Hash

Description

Validator for the sha1 hash of given files

Methods

Name Description Defined By
__construct() Sets validator options Hash
__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
addHash() Adds the hash for one or multiple files Hash
addSha1() Adds the sha1 hash for one or multiple files Sha1
getDefaultTranslator() Get default translation object for all validate objects AbstractValidator
getDefaultTranslatorTextDomain() Get default translation text domain for all validate objects AbstractValidator
getHash() Returns the set hash values as array, the hash as key and the algorithm the value Hash
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
getOption() Returns an option AbstractValidator
getOptions() Returns all available options AbstractValidator
getSha1() Returns all set sha1 hashes Sha1
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
isTranslatorEnabled() Is translation enabled? AbstractValidator
isValid() Returns true if and only if the given file confirms the set hash Sha1
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
setHash() Sets the hash for one or multiple files Hash
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
setOptions() Sets one or multiple options AbstractValidator
setSha1() Sets the sha1 hash for one or multiple files Sha1
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 string|array

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

addHash()

Adds the hash for one or multiple files

Parameter Name Type Description
$options string|array

Returns: self Provides a fluent interface

addSha1()

Adds the sha1 hash for one or multiple files

Parameter Name Type Description
$options string|array

Returns: \Hash Provides a fluent 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

getHash()

Returns the set hash values as array, the hash as key and the algorithm the value

Returns: array

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

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

getSha1()

Returns all set sha1 hashes

Returns: array

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

isTranslatorEnabled()

Is translation enabled?

Returns: bool

isValid()

Returns true if and only if the given file confirms the set hash

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

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

setHash()

Sets the hash for one or multiple files

Parameter Name Type Description
$options string|array

Returns: self Provides a fluent 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

setOptions()

Sets one or multiple options

Parameter Name Type Description
$options array|\Traversable Options

Returns: \AbstractValidator Provides fluid interface

setSha1()

Sets the sha1 hash for one or multiple files

Parameter Name Type Description
$options string|array

Returns: \Hash Provides a fluent 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