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

Class: BuildEvent

Source Location: /BuildEvent.php

Class Overview

EventObject
   |
   --BuildEvent

Encapsulates a build specific event.


Author(s):

Version:

  • $Revision: 526 $

Variables

Methods


Inherited Variables

Inherited Methods

Class: EventObject

EventObject::__construct()
Constructs a prototypical Event.
EventObject::getSource()
The object on which the Event initially occurred.
EventObject::toString()
Returns a String representation of this EventObject.

Class Details

[line 43]
Encapsulates a build specific event.

We have three sources of events all handled by this class:

  • Project level events
  • Target level events
  • Task level events

Events are all fired from the project class by creating an event object using this class and passing it to the listeners.




Tags:

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


[ Top ]


Class Variables

$exception =  null

[line 83]

The execption that caused the event, if any



Tags:

access:  protected

Type:   object


[ Top ]

$message =  null

[line 68]

The message of this event, if the event is a message



Tags:

access:  protected

Type:   string


[ Top ]

$priority =  Project::MSG_VERBOSE

[line 76]

The priority of the message



Tags:

see:  BuildEvent::$message
access:  protected

Type:   string


[ Top ]

$project =

[line 49]

A reference to the project



Tags:

access:  protected

Type:   Project


[ Top ]

$target =

[line 55]

A reference to the target



Tags:

access:  protected

Type:   Target


[ Top ]

$task =

[line 62]

A reference to the task



Tags:

access:  protected

Type:   Task


[ Top ]



Class Methods


constructor __construct [line 90]

BuildEvent __construct( object project $source)

Construct a BuildEvent for a project, task or target source event



Tags:

access:  public


Overrides EventObject::__construct() (Constructs a prototypical Event.)

Parameters:

object project   $source   the project that emitted the event.

[ Top ]

method getException [line 195]

Exception getException( )

Returns the exception that was thrown, if any.

This field will only be set for "taskFinished", "targetFinished", and "buildFinished" events.




Tags:



[ Top ]

method getMessage [line 171]

string getMessage( )

Returns the logging message. This field will only be set for "messageLogged" events.



Tags:

return:  The log message


[ Top ]

method getPriority [line 181]

integer getPriority( )

Returns the priority of the logging message. This field will only be set for "messageLogged" events.



Tags:

return:  The message priority


[ Top ]

method getProject [line 137]

Project getProject( )

Returns the project instance that fired this event.

The reference to the project instance is set by the constructor if this event was fired from the project class.




Tags:

return:  The project instance that fired this event
access:  public


[ Top ]

method getTarget [line 149]

Target getTarget( )

Returns the target instance that fired this event.

The reference to the target instance is set by the constructor if this event was fired from the target class.




Tags:

return:  The target that fired this event
access:  public


[ Top ]

method getTask [line 161]

Task getTask( )

Returns the target instance that fired this event.

The reference to the task instance is set by the constructor if this event was fired within a task.




Tags:

return:  The task that fired this event
access:  public


[ Top ]

method setException [line 125]

void setException( Exception $exception)

Set the exception that was the cause of this event.



Tags:

access:  public


Parameters:

Exception   $exception   The exception that caused the event

[ Top ]

method setMessage [line 115]

void setMessage( string $message, integer $priority)

Sets the message with details and the message priority for this event.



Tags:

access:  public


Parameters:

string   $message   The string message of the event
integer   $priority   The priority this message should have

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:26 +0200 by phpDocumentor 1.4.3