Zend_Validate_File_Sha1 Class Reference

Inheritance diagram for Zend_Validate_File_Sha1:

Public Member Functions
	__construct ($options)
	getSha1 ()
	setHash ($options)
	setSha1 ($options)
	addHash ($options)
	addSha1 ($options)
	isValid ($value, $file=null)
Public Member Functions inherited from Zend_Validate_File_Hash
	__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 = 'fileSha1DoesNotMatch'
const	NOT_DETECTED = 'fileSha1NotDetected'
const	NOT_FOUND = 'fileSha1NotFound'
Data Fields inherited from Zend_Validate_File_Hash
const	DOES_NOT_MATCH = 'fileHashDoesNotMatch'
const	NOT_DETECTED = 'fileHashHashNotDetected'
const	NOT_FOUND = 'fileHashNotFound'

Protected Attributes
	$_messageTemplates
	$_hash
Protected Attributes inherited from Zend_Validate_File_Hash
	$_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)
Protected Member Functions inherited from Zend_Validate_File_Hash
	_throw ($file, $errorType)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file Sha1.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

$hash is the hash we accept for the file $file

Parameters

string | array

$options

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_File_Sha1

Definition at line 69 of file Sha1.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');
        }

        $this->setHash($options);
    }

Member Function Documentation

addHash()

addHash

(

$options

)

Adds the sha1 hash for one or multiple files

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 128 of file Sha1.php.

    {
        if (!is_array($options)) {
            $options = (array) $options;
        }

        $options['algorithm'] = 'sha1';
        parent::addHash($options);
        return $this;
    }

addSha1()

addSha1

(

$options

)

Adds the sha1 hash for one or multiple files

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 145 of file Sha1.php.

    {
        $this->addHash($options);
        return $this;
    }

getSha1()

getSha1

(

)

Returns all set sha1 hashes

Returns

array

Definition at line 88 of file Sha1.php.

    {
        return $this->getHash();
    }

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 160 of file Sha1.php.

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

        $hashes = array_unique(array_keys($this->_hash));
        $filehash = hash_file('sha1', $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 sha1 hash for one or multiple files

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 99 of file Sha1.php.

    {
        if (!is_array($options)) {
            $options = (array) $options;
        }

        $options['algorithm'] = 'sha1';
        parent::setHash($options);
        return $this;
    }

setSha1()

setSha1

(

$options

)

Sets the sha1 hash for one or multiple files

Parameters

string | array

$options

Returns

Zend_Validate_File_Hash Provides a fluent interface

Definition at line 116 of file Sha1.php.

    {
        $this->setHash($options);
        return $this;
    }

Field Documentation

$_hash

$_hash

protected

Definition at line 58 of file Sha1.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::DOES_NOT_MATCH => "File '%value%' does not match the given sha1 hashes",
        self::NOT_DETECTED   => "A sha1 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 Sha1.php.

DOES_NOT_MATCH

const DOES_NOT_MATCH = 'fileSha1DoesNotMatch'

@const string Error constants

Definition at line 40 of file Sha1.php.

NOT_DETECTED

const NOT_DETECTED = 'fileSha1NotDetected'

Definition at line 41 of file Sha1.php.

NOT_FOUND

const NOT_FOUND = 'fileSha1NotFound'

Definition at line 42 of file Sha1.php.

---

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

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