tasks/ext/ManifestTask.php

Show:

inherited

Classes
- \ManifestTask

Table of Contents

\ManifestTask
jump to top

Package: phing\tasks\ext

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

"r" for reading in files from fileSet and checking against manifest

Default value'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

Default valuefalseDetails

Type: mixed

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description


                 $destFile= 'null'

The target file passed in the buildfile.

Default valuenullDetails

Type: n/a

array
                 $filesets= 'array()'

Holds filesets

An Array of objects

Default valuearray()Details

Type: array

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

array
                 $meta= 'array('totalFileCount' => 0,'totalFileSize' => 0)'

Holds some data collected during runtime

Default valuearray('totalFileCount' => 0,'totalFileSize' => 0)Details

Type: array

\Project
                 $project= 'null'

inherited

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::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project

string
                 $salt= ''''

A string used in hashing method

Default value''Details

Type: string

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType


                 $taskname= ''manifest''

Default value'manifest'Details

Type: n/a

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

createFileSet(
          
          )
        
        :
          object

Nested creator, creates a FileSet for this task

Returns

Type	Description
object	The created fileset object

Details

Access: public

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \Location

inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()

Returns

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

Parameters

Name	Type	Description
$msg	string	The string that should be hashed
$algo	string	Algorithm

Returns

Type	Description
mixed	String on success, false if $algo is not available

Details

Link: http://www.php.net/mhash
Link: http://www.php.net/hash

hashFile(
          string $file, string $algo
          )
        
        :
          mixed

Hash a files contents plus it's size an modification time

Parameters

Name	Type	Description
$file	string
$algo	string

Returns

Type	Description
mixed	String on success, false if $algo is not available

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.

Throws

Exception	Description
\BuildException

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

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

inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

Details

Todo: implement

setChecksum(
          mixed $mixed
          )
        
        :
          void

The setter for the attribute "checksum"

Parameters

Name	Type	Description
$mixed	mixed

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

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

Parameters

Name	Type	Description
$file	string	Path to readable file

setLocation(
          \Location $location
          )
        
        :
          void

inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setSalt(
          string $string
          )
        
        :
          void

The setter for the optional attribute "salt"

Parameters

Name	Type	Description
$string	string

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

validateAttributes(
          
          )
        
        :
          void

Validates attributes coming in from XML

Throws

Exception	Description
\BuildException

Details

Access: private

Creates Manifest file Writes to $this->file

Throws

Exception	Description
\BuildException

tasks/ext/ManifestTask.php

\ManifestTaskjump to top

Properties

Methods

\ManifestTask
jump to top