phing
[ class tree: phing ] [ index: phing ] [ all elements ]

Class: ProjectComponent

Source Location: /ProjectComponent.php

Class Overview


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


Author(s):

Version:

  • $Revision: 526 $

Variables

Methods


Child classes:

IsFalseCondition
Condition that tests whether a given string evals to false.
IsTrueCondition
Condition that tests whether a given string evals to true.
ConditionBase
Abstract baseclass for the <condition> task as well as several conditions - ensures that the types of conditions inside the task and the "container" conditions are in sync.
ReferenceExistsCondition
Condition that tests whether a given reference exists.
IsSetCondition
Condition that tests whether a given property has been set.
DataType
Base class for those classes that can appear inside the build file as stand alone data types.
Task
The base class for all Tasks.

Class Details

[line 31]
Abstract class providing properties and methods common to all the project components



Tags:

author:  Hans Lellelid <hans@xmpl.org>
author:  Andreas Aderhold <andi@binarycloud.com>
version:  $Revision: 526 $
abstract:  


[ Top ]


Class Variables

$project =  null

[line 39]

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



Tags:

var:  A reference to the current project instance
access:  protected

Type:   Project


[ Top ]



Class Methods


method getProject [line 55]

Project getProject( )

Returns a reference to current project



Tags:

return:  Reference to current porject object
access:  public


[ Top ]

method log [line 65]

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

Logs a message with the given priority.



Tags:

access:  public


Overridden in child classes as:

Task::log()
Provides a project level log event to the task.

Parameters:

string   $msg   The message to be logged.
integer   $level   The message's priority at this message should have

[ Top ]

method setProject [line 46]

void setProject( Project $project)

References the project to the current component.



Tags:

access:  public


Overridden in child classes as:

MatchingTask::setProject()

Parameters:

Project   $project   The reference to the current project

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:48 +0200 by phpDocumentor 1.4.3