BuildEvent.php

Show:

inherited

Classes
- \BuildEvent

Table of Contents

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: $Id$

\BuildEvent
jump to top

Package: phing

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.

Parent(s): \EventObject
Author: Andreas Aderhold
Author: Hans Lellelid
Version: $Id$

Properties

object
                 $exception= 'null'

The execption that caused the event, if any

Default valuenullDetails

Type: object

string
                 $message= 'null'

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

Default valuenullDetails

Type: string

string
                 $priority= 'Project::MSG_VERBOSE'

The priority of the message

Default valueProject::MSG_VERBOSEDetails

Type: string
See: \$message

\Project
                 $project= ''

A reference to the project

Details

Type: \Project


                 $source= ''

inherited

The object on which the Event initially occurred.

Inherited from: \EventObject::$$source

Details

Type: n/a
Inherited_from: \EventObject::$$source

\Target
                 $target= ''

A reference to the target

Details

Type: \Target

\Task
                 $task= ''

A reference to the task

Details

Type: \Task

Methods

__construct(
          object $source
          )
        
        :
          void

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

Parameters

Name	Type	Description
$source	object	project the project that emitted the event.

getException(
          
          )
        
        :
          \Exception

Returns the exception that was thrown, if any.

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

Returns

Type	Description
\Exception

Details

See: \BuildListener::taskFinished()
See: \BuildListener::targetFinished()
See: \BuildListener::buildFinished()

getMessage(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The log message

getPriority(
          
          )
        
        :
          integer

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

Returns

Type	Description
integer	The message priority

getProject(
          
          )
        
        :
          \Project

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.

Returns

Type	Description
\Project	The project instance that fired this event

getSource(
          
          )
        
        :
          void

inherited

The object on which the Event initially occurred.

Inherited from: \EventObject::getSource()

getTarget(
          
          )
        
        :
          \Target

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.

Returns

Type	Description
\Target	The target that fired this event

getTask(
          
          )
        
        :
          \Task

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.

Returns

Type	Description
\Task	The task that fired this event

setException(
          \Exception $exception
          )
        
        :
          void

Set the exception that was the cause of this event.

Parameters

Name	Type	Description
$exception	\Exception	The exception that caused the event

setMessage(
          string $message, integer $priority
          )
        
        :
          void

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

Parameters

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

toString(
          
          )
        
        :
          void

inherited

Returns a String representation of this EventObject.

Inherited from: \EventObject::toString()

BuildEvent.php

\BuildEventjump to top

Properties

Methods

\BuildEvent
jump to top