Validate/File/Md5.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_File_Md5

Package: Zend_Validate
Validator for the md5 hash of given files
Parent(s)
\Zend_Validate_File_Hash < \Zend_Validate_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  DOES_NOT_MATCH = 'fileMd5DoesNotMatch'
Const
string Error constants  
>VConstant  NOT_DETECTED = 'fileMd5NotDetected'
>VConstant  NOT_FOUND = 'fileMd5NotFound'

Properties

>VPropertyprotectedstring $_hash
Hash of the file
Details
Type
string
>VPropertyprotectedarray $_messageTemplates = array(self::DOES_NOT_MATCH => "File '%value%' does not match the given md5 hashes", self::NOT_DETECTED => "A md5 hash could not be evaluated for the given file", self::NOT_FOUND => "File '%value%' is not readable or does not exist")

Error message templates

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

Methods

methodpublic__construct(string | array $options) : void

Sets validator options

$hash is the hash we accept for the file $file
Parameters
NameTypeDescription
$optionsstring | array
methodpublicaddHash(string | array $options) : \Zend_Validate_File_Hash

Adds the md5 hash for one or multiple files

Parameters
NameTypeDescription
$optionsstring | array
Returns
TypeDescription
\Zend_Validate_File_HashProvides a fluent interface
methodpublicaddMd5(string | array $options) : \Zend_Validate_File_Hash

Adds the md5 hash for one or multiple files

Parameters
NameTypeDescription
$optionsstring | array
Returns
TypeDescription
\Zend_Validate_File_HashProvides a fluent interface
methodpublicgetMd5() : array

Returns all set md5 hashes

Returns
TypeDescription
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
NameTypeDescription
$valuestring

Filename to check for hash

$filearray

File data from Zend_File_Transfer

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

Sets the md5 hash for one or multiple files

Parameters
NameTypeDescription
$optionsstring | array
Returns
TypeDescription
\Zend_Validate_File_HashProvides a fluent interface
methodpublicsetMd5(string | array $options) : \Zend_Validate_File_Hash

Sets the md5 hash for one or multiple files

Parameters
NameTypeDescription
$optionsstring | array
Returns
TypeDescription
\Zend_Validate_File_HashProvides a fluent interface
Documentation was generated by phpDocumentor 2.2.0 .