phing-tasks-ext
[ class tree: phing-tasks-ext ] [ index: phing-tasks-ext ] [ all elements ]

Class: FileHashTask

Source Location: /tasks/ext/FileHashTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --FileHashTask

fileHash


Author(s):

Version:

  • $Id: FileHashTask.php 590 2009-09-29 09:59:51Z johan162 $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Methods


Inherited Variables

Inherited Methods

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
Task::main()
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 33]
fileHash

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




Tags:

author:  Johan Persson <johan162@gmail.com>
version:  $Id: FileHashTask.php 590 2009-09-29 09:59:51Z johan162 $
copyright:  � 2001,2002 THYRELL. All rights reserved


[ Top ]


Class Methods


method main [line 91]

void main( )

Main-Method for the Task



Tags:

throws:  BuildException
access:  public


Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.)

[ Top ]

method setFile [line 70]

void setFile( PhingFile $file)

Which file for calculate the has value of



Tags:

access:  public


Parameters:

PhingFile   $file  

[ Top ]

method setHashtype [line 61]

void setHashtype( integer $type)

Specify if MD5 or SHA1 hash should be used



Tags:

access:  public


Parameters:

integer   $type   0=MD5, 1=SHA1

[ Top ]

method setPropertyName [line 80]

void setPropertyName( $property $property)

Set the name of the property to use to return the has value



Tags:

access:  public


Parameters:

$property   $property  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:54 +0200 by phpDocumentor 1.4.3