ProjectComponent

Abstract class providing properties and methods common to all the project components

author

Andreas Aderhold [email protected]

author

Hans Lellelid [email protected]

package

phing

Methods

__construct

__construct() 

Returns the description of the current action.

getDescription() : string

Response

string

the description of the current action, or null if no description is available.

Returns the file/location where this task was defined.

getLocation() : \Location

Response

\Location

the file/location where this task was defined. Should not return null.

Returns a reference to current project

getProject() : \Project

Response

\Project

Reference to current porject object

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

Sets the file/location where this task was defined.

setLocation(\Location $location) 

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

References the project to the current component.

setProject(\Project $project) : void

Arguments

$project

\Project

The reference to the current project

Properties

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
var

A reference to the current project instance

Type(s)

\Project

location

location : \Location
var

Type(s)

\Location

description

description : string
var

Type(s)

string