Zend_Validate_File_Hash Class Reference

Inheritance diagram for Zend_Validate_File_Hash:

Public Member Functions
	__construct ($options)
	getHash ()
	setHash ($options)
	addHash ($options)
	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	DOES_NOT_MATCH = 'fileHashDoesNotMatch'
const	NOT_DETECTED = 'fileHashHashNotDetected'
const	NOT_FOUND = 'fileHashNotFound'

Protected Member Functions
	_throw ($file, $errorType)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

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)
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 Hash.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

Parameters

string | array

$options

Exceptions

Zend_Validate_Exception

Definition at line 66 of file Hash.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_scalar($options)) {
            $options = array('hash1' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception('Invalid options to validator provided');
        }

        if (1 < func_num_args()) {
            $options['algorithm'] = func_get_arg(1);
        }

        $this->setHash($options);
    }

Member Function Documentation

_throw()

_throw (   $file,   $errorType  )

protected

Throws an error of the given type

Parameters

string	$file
string	$errorType

Returns

false

Definition at line 186 of file Hash.php.

    {
        if ($file !== null) {
            $this->_value = $file['name'];
        }

        $this->_error($errorType);
        return false;
    }

addHash()

addHash

(

$options

)

Adds the hash for one or multiple files

Parameters

string | array

$options

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 115 of file Hash.php.

    {
        if (is_string($options)) {
            $options = array($options);
        } else if (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("False parameter given");
        }

        $known = hash_algos();
        if (!isset($options['algorithm'])) {
            $algorithm = 'crc32';
        } else {
            $algorithm = $options['algorithm'];
            unset($options['algorithm']);
        }

        if (!in_array($algorithm, $known)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("Unknown algorithm '{$algorithm}'");
        }

        foreach ($options as $value) {
            $this->_hash[$value] = $algorithm;
        }

        return $this;
    }

getHash()

getHash

(

)

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

Returns

array

Definition at line 89 of file Hash.php.

    {
        return $this->_hash;
    }

isValid()

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

Definition at line 153 of file Hash.php.

    {
        // Is file readable ?
        #require_once 'Zend/Loader.php';
        if (!Zend_Loader::isReadable($value)) {
            return $this->_throw($file, self::NOT_FOUND);
        }

        $algos  = array_unique(array_values($this->_hash));
        $hashes = array_unique(array_keys($this->_hash));
        foreach ($algos as $algorithm) {
            $filehash = hash_file($algorithm, $value);
            if ($filehash === false) {
                return $this->_throw($file, self::NOT_DETECTED);
            }

            foreach($hashes as $hash) {
                if ($filehash === $hash) {
                    return true;
                }
            }
        }

        return $this->_throw($file, self::DOES_NOT_MATCH);
    }

setHash()

setHash

(

$options

)

Sets the hash for one or multiple files

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 100 of file Hash.php.

    {
        $this->_hash  = null;
        $this->addHash($options);

        return $this;
    }

Field Documentation

$_hash

$_hash

protected

Definition at line 58 of file Hash.php.

$_messageTemplates

$_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"
    )

Definition at line 47 of file Hash.php.

DOES_NOT_MATCH

const DOES_NOT_MATCH = 'fileHashDoesNotMatch'

@const string Error constants

Definition at line 40 of file Hash.php.

NOT_DETECTED

const NOT_DETECTED = 'fileHashHashNotDetected'

Definition at line 41 of file Hash.php.

NOT_FOUND

const NOT_FOUND = 'fileHashNotFound'

Definition at line 42 of file Hash.php.

---

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

• vendor/magento/zendframework1/library/Zend/Validate/File/Hash.php