Description is used to provide a project-wide description element (that is, a description that applies to a buildfile as a whole).
If present, the <description> element is printed out before the target descriptions.
Description has no attributes, only text. There can only be one project description per project. A second description element will overwrite the first.
| author |
Hans Lellelid [email protected] (Phing) |
|---|---|
| author |
Craeg Strong [email protected] (Ant) |
| package |
phing.types |
__construct()
addText( $text) : void
circularReference() : \BuildException
dieOnCircularReference( &$stk, \Project $p) : void
If one is included, throw a BuildException created by circularReference
This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.
| Throws |
|
|---|
\Project
getCheckedRef( $requiredClass, $dataTypeName) : mixed
| Throws |
|
|---|
mixed
getDescription() : string
stringthe description of the current action, or null if
no description is available.
getLocation() : \Location
getProject() : \Project
isReference() : boolean
boolean
log(string $msg, integer $level = \Project::MSG_INFO) : void
stringThe message to be logged.
integerThe message's priority at this message should have
noChildrenAllowed() : \BuildException
parsingComplete() : void
{@inheritdoc}
pushAndInvokeCircularReferenceCheck(\DataType $dt, &$stk, \Project $p)
setChecked(boolean $checked)
boolean
setDescription(string $desc)
stringDescription of the current action.
May be null, indicating that no description is
available.
setLocation(\Location $location)
setProject(\Project $project) : void
setRefid(\Reference $r) : void
Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()
\Reference
tooManyAttributes() : \BuildException
checked : boolean
Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).
| var |
|---|
boolean
project : \Project
description : string
| var |
|---|
string