tasks/ext/ManifestTask.php
\ManifestTask
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:
- Parent(s)
- \Task < \ProjectComponent
- Author
- David Persson
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.3.1
- Version
- $Id: 7f8f119fe5dd44ca9f374e24d776a1a764260e33 $
Properties


string
$action= ''w''
Action
"r" or "w""w" for reading in files from fileSet and writing manifest
or
"r" for reading in files from fileSet and checking against manifest
'w'
Details- Type
- string


mixed
$checksum= 'false'
Enable/Disable checksuming or/and select algorithm true defaults to md5 false disables checksuming string "md5,sha256,..." enables generation of multiple checksums string "sha256" generates sha256 checksum only
false
Details- Type
- mixed


array
$meta= 'array('totalFileCount' => 0,'totalFileSize' => 0)'
Holds some data collected during runtime
array('totalFileCount' => 0,'totalFileSize' => 0)
Details- Type
- array


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


createFileSet(
)
:
object
Nested creator, creates a FileSet for this task
Type | Description |
---|---|
object | The created fileset object |
- Access
- public


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


hash(
string $msg, string $algo
)
:
mixed
Wrapper method for hash generation Automatically selects extension Falls back to built-in functions
Name | Type | Description |
---|---|---|
$msg | string | The string that should be hashed |
$algo | string | Algorithm |
Type | Description |
---|---|
mixed | String on success, false if $algo is not available |


hashFile(
string $file, string $algo
)
:
mixed
Hash a files contents plus it's size an modification time
Name | Type | Description |
---|---|---|
$file | string | |
$algo | string |
Type | Description |
---|---|
mixed | String on success, false if $algo is not available |


init(
)
:
void
The init method: Do init steps.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Delegate the work
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setChecksum(
mixed $mixed
)
:
void
The setter for the attribute "checksum"
Name | Type | Description |
---|---|---|
$mixed | mixed |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setFile(
string $file
)
:
void
The setter for the attribute "file" This is where the manifest will be written to/read from
Name | Type | Description |
---|---|---|
$file | string | Path to readable file |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setSalt(
string $string
)
:
void
The setter for the optional attribute "salt"
Name | Type | Description |
---|---|---|
$string | string |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |


validateAttributes(
)
:
void
Validates attributes coming in from XML
Exception | Description |
---|---|
\BuildException |
- Access
- private


write(
)
:
void
Creates Manifest file Writes to $this->file
Exception | Description |
---|---|
\BuildException |