phing-tasks-ext

# Class: ManifestTask Source Location: /tasks/ext/ManifestTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --ManifestTask
ManifestTask #### Author(s): David Persson <at qeweurope dot org davidpersson at qeweurope dot org> #### Version: $Id: ManifestTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Variables $taskname | ### Methods createFileSet init main setChecksum setFile setSalt validateAttributes
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### 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 53] ManifestTask Generates a simple Manifest file with optional checksums. Manifest schema: ... path/to/file CHECKSUM [CHECKSUM2] [CHECKSUM3] path/to/secondfile CHECKSUM [CHECKSUM2] [CHECKSUM3] ... Example usage: <manifest checksum="crc32" file="${dir_build}/Manifest"> <fileset refid="files_build" /> </manifest> <manifest checksum="md5,adler32,sha256" file="${dir_build}/Manifest"> <fileset refid="files_build" /> </manifest> #### Tags:
author: | David Persson <at qeweurope dot org davidpersson at qeweurope dot org>
version: | $Id: ManifestTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
since: | 2.3.1
[ Top ] ### Class Variables #### $taskname = 'manifest' [line 55]
Type: | mixed
[ Top ] ### Class Methods ### method createFileSet [line 162]
`object The createFileSet( )`
Nested creator, creates a FileSet for this task #### Tags:
return: | created fileset object
access: | public
[ Top ] ### method init [line 171]
`void init( )`
The init method: Do init steps. #### Tags:
access: | public
Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method main [line 179]
`void main( )`
Delegate the work #### Tags:
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 setChecksum [line 128]
`void setChecksum( mixed $mixed)`
The setter for the attribute "checksum" #### Tags:
access: | public
#### Parameters:
mixed | $mixed |
[ Top ] ### method setFile [line 117]
`void setFile( $file)`
The setter for the attribute "file" This is where the manifest will be written to/read from #### Tags:
access: | public
#### Parameters:
string | $file | Path to readable file
[ Top ] ### method setSalt [line 151]
`void setSalt( string $string)`
The setter for the optional attribute "salt" #### Tags:
access: | public
#### Parameters:
string | $string |
[ Top ] ### method validateAttributes [line 322]
`void validateAttributes( )`
Validates attributes coming in from XML #### Tags:
throws: | BuildException
access: | protected
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:14 +0200 by phpDocumentor 1.4.3