classes/phing/BuildEvent.php
Classes
Encapsulates a build specific event.
<
p>We have three sources of events all handled by this class:
- Project level events
- Target level events
- Task level events
<
p> Events are all fired from the project class by creating an event object using this class and passing it to the listeners.
- author
- Andreas Aderhold
- author
- Hans Lellelid
- package
- phing
- version
- $Revision: 526 $
\BuildEvent
Encapsulates a build specific event.
<
p>We have three sources of events all handled by this class:
- Project level events
- Target level events
- Task level events
<
p> Events are all fired from the project class by creating an event object using this class and passing it to the listeners.
- Extends from
- \EventObject
- author
- Andreas Aderhold
- author
- Hans Lellelid
- package
- phing
- version
- $Revision: 526 $
Properties
object
$exception= 'null'
The execption that caused the event, if any
nullDetails- Type
- object
string
$message= 'null'
The message of this event, if the event is a message
nullDetails- Type
- string
string
$priority= 'Project'
The priority of the message
ProjectDetails- Type
- string
- see
- \$message
\Project
$project= ''
A reference to the project
- Type
- \Project
\Target
$target= ''
A reference to the target
- Type
- \Target
\Task
$task= ''
A reference to the task
- Type
- \Task
Methods
__construct(
object $source
)
:
| Name | Type | Description |
|---|---|---|
| $source | object | project the project that emitted the event. |
getException(
)
:
\ExceptionThis field will only be set for "taskFinished", "targetFinished", and "buildFinished" events.
| Type | Description |
|---|---|
| \Exception |
getMessage(
)
:
string| Type | Description |
|---|---|
| string |
getPriority(
)
:
integer| Type | Description |
|---|---|
| integer |
getProject(
)
:
\ProjectThe reference to the project instance is set by the constructor if this event was fired from the project class.
| Type | Description |
|---|---|
| \Project |
getTarget(
)
:
\TargetThe reference to the target instance is set by the constructor if this event was fired from the target class.
| Type | Description |
|---|---|
| \Target |
getTask(
)
:
\TaskThe reference to the task instance is set by the constructor if this event was fired within a task.
| Type | Description |
|---|---|
| \Task |
setException(
\Exception $exception
)
:
| Name | Type | Description |
|---|---|---|
| $exception | \Exception | The exception that caused the event |
setMessage(
string $message, integer $priority
)
:
| Name | Type | Description |
|---|---|---|
| $message | string | The string message of the event |
| $priority | integer | The priority this message should have |