tasks/ext/FileHashTask.php

Show: inherited
Table of Contents

fileHash

Calculate either MD5 or SHA hash value of a specified file and retun the value in a property

Author
Johan Persson  
Package
phing.tasks.ext  
Version
$Id: FileHashTask.php 1084 2011-05-06 09:55:25Z mrook $  

\FileHashTask

Package: phing\tasks\ext

fileHash

Calculate either MD5 or SHA hash value of a specified file and retun the value in a property

Parent(s)
\Task < \ProjectComponent
Author
Johan Persson  
Version
$Id: FileHashTask.php 1084 2011-05-06 09:55:25Z mrook $  

Properties

Propertyprivate\PhingFile  $file= ''

Property for File

file
Details
Type
\PhingFile
Propertyprivateinteger  $hashtype= '0'

Specify which hash algorithm to use.

0 = MD5 1 = SHA1

Default value0Details
Type
integer
Propertyprivatestring  $propertyName= '"filehashvalue"'

Property to be set

Default value"filehashvalue"Details
Type
string

Methods

methodprivatecheckFile( ) : void

checks file attribute

Throws
Exception Description
\BuildException
methodprivatecheckPropertyName( ) : void

checks property attribute

Throws
Exception Description
\BuildException
methodpublicgetDescription( ) : void

methodpublicgetLocation( ) : void

methodpublicgetOwningTarget( ) : void

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicinit( ) : void

methodpubliclog( ) : void

methodpublicmain( ) : void

Main-Method for the Task

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetDescription( ) : void

methodpublicsetFile( \PhingFile $file ) : void

Which file to calculate the hash value of

Parameters
Name Type Description
$file \PhingFile
methodpublicsetHashtype( integer $type ) : void

Specify if MD5 or SHA1 hash should be used

Parameters
Name Type Description
$type integer

0=MD5, 1=SHA1

methodpublicsetLocation( ) : void

methodpublicsetOwningTarget( ) : void

methodpublicsetProject( ) : void

methodpublicsetPropertyName(  $property ) : void

Set the name of the property to store the hash value in

Parameters
Name Type Description
$property
methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

Documentation was generated by DocBlox 0.17.1.