Zend_Validate_File_Hash Class Reference

Public Member Functions
	__construct ($options)
	Sets validator options.
	getHash ()
	Returns the set hash values as array, the hash as key and the algorithm the value.
	setHash ($options)
	Sets the hash for one or multiple files.
	addHash ($options)
	Adds the hash for one or multiple files.
	isValid ($value, $file=null)
	Defined by Zend_Validate_Interface.
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	Returns array of validation failure messages.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	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.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	getErrors ()
	Returns array of validation failure message codes.
	setObscureValue ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	getObscureValue ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator ($translator=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)
	Returns true if and only if $value meets the validation requirements.

Public Attributes
const	DOES_NOT_MATCH = 'fileHashDoesNotMatch'
	string Error constants
const	NOT_DETECTED = 'fileHashHashNotDetected'
const	NOT_FOUND = 'fileHashNotFound'

Protected Member Functions
	_throw ($file, $errorType)
	Throws an error of the given type.
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	_error ($messageKey, $value=null)
	_setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.

Protected Attributes
	$_messageTemplates
	$_hash
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)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options

)

Sets validator options.

Parameters

string | array

$options

Returns

void

Member Function Documentation

_throw (   $file,   $errorType  )

protected

Throws an error of the given type.

Parameters

string	$file
string	$errorType

Returns

false

addHash

(

$options

)

Adds the hash for one or multiple files.

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

getHash

(

)

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

Returns

array

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface.

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

Parameters

string	$value	Filename to check for hash
array	$file	File data from Zend_File_Transfer

Returns

boolean

setHash

(

$options

)

Sets the hash for one or multiple files.

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Member Data Documentation

$_hash

protected

$_messageTemplates

protected

Initial value:

= array(
        self::DOES_NOT_MATCH => "File '%value%' does not match the given hashes",
        self::NOT_DETECTED   => "A hash could not be evaluated for the given file",
        self::NOT_FOUND      => "File '%value%' is not readable or does not exist"
    )

const DOES_NOT_MATCH = 'fileHashDoesNotMatch'

string Error constants

const NOT_DETECTED = 'fileHashHashNotDetected'

const NOT_FOUND = 'fileHashNotFound'