API Documentation

Zend/Validate/File/Hash.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id: Hash.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Validate_File_Hash

Package: Zend\Validate

Validator for the hash of given files

Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Validate_File_Crc32
\Zend_Validate_File_Md5
\Zend_Validate_File_Sha1
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  DOES_NOT_MATCH = 'fileHashDoesNotMatch'

Const
string Error constants  
Constant  NOT_DETECTED = 'fileHashHashNotDetected'
Constant  NOT_FOUND = 'fileHashNotFound'

Properties

Propertyprotectedstring  $_hash= ''

Hash of the file

Details
Type
string
Propertyprotectedarray  $_messageTemplates= 'array( self::DOES_NOT_MATCH => "File '%value%' does not match the given hashes"'

Error message templates
Default valuearray( self::DOES_NOT_MATCH => "File '%value%' does not match the given hashes"Details
Type
array

Methods

methodpublic__construct( string|array $options ) : void

Sets validator options

Parameters
Name Type Description
$options string|array
methodprotected_throw( string $file, string $errorType ) : false

Throws an error of the given type

Parameters
Name Type Description
$file string
$errorType string
Returns
Type Description
false
methodpublicaddHash( string|array $options ) : \Zend_Validate_File_Hash

Adds the hash for one or multiple files

Parameters
Name Type Description
$options string|array
Returns
Type Description
\Zend_Validate_File_Hash Provides a fluent interface
methodpublicgetHash( ) : array

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

Returns
Type Description
array
methodpublicisValid( string $value, array $file = null ) : boolean

Defined by Zend_Validate_Interface

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

Parameters
Name Type Description
$value string

Filename to check for hash

$file array

File data from Zend_File_Transfer

Returns
Type Description
boolean
methodpublicsetHash( string|array $options ) : \Zend_Validate_File_Hash

Sets the hash for one or multiple files

Parameters
Name Type Description
$options string|array
Returns
Type Description
\Zend_Validate_File_Hash Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.