diff options
Diffstat (limited to 'buildscripts/phing/classes/phing/BuildEvent.php')
| -rwxr-xr-x[-rw-r--r--] | buildscripts/phing/classes/phing/BuildEvent.php | 117 |
1 files changed, 55 insertions, 62 deletions
diff --git a/buildscripts/phing/classes/phing/BuildEvent.php b/buildscripts/phing/classes/phing/BuildEvent.php index d4e1ea79..581f7cf4 100644..100755 --- a/buildscripts/phing/classes/phing/BuildEvent.php +++ b/buildscripts/phing/classes/phing/BuildEvent.php @@ -1,6 +1,6 @@ <?php /* - * $Id: BuildEvent.php,v 1.10 2005/12/22 22:44:46 hlellelid Exp $ + * $Id: 47c800dd15c2367bb5890065f96ffceb7ae9ba55 $ * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT @@ -37,61 +37,57 @@ require_once 'phing/system/lang/EventObject.php'; * * @author Andreas Aderhold <andi@binarycloud.com> * @author Hans Lellelid <hans@xmpl.org> - * @version $Revision: 1.10 $ + * @version $Id$ * @package phing */ class BuildEvent extends EventObject { /** - * A reference to the project - * @var Project + * A reference to the project + * @var Project */ protected $project; /** - * A reference to the target - * @var Target + * A reference to the target + * @var Target */ protected $target; /** - * A reference to the task + * A reference to the task * - * @var Task + * @var Task */ protected $task; /** - * The message of this event, if the event is a message - * @var string - * @access private + * The message of this event, if the event is a message + * @var string */ protected $message = null; /** - * The priority of the message + * The priority of the message * - * @var string - * @see $message - * @access private + * @var string + * @see $message */ - protected $priority = PROJECT_MSG_VERBOSE; + protected $priority = Project::MSG_VERBOSE; /** - * The execption that caused the event, if any + * The execption that caused the event, if any * - * @var object - * @access private + * @var object */ protected $exception = null; /** - * Construct a BuildEvent for a project, task or target source event + * Construct a BuildEvent for a project, task or target source event * - * @param object project the project that emitted the event. - * @access public + * @param object project the project that emitted the event. */ - function __construct($source) { + public function __construct($source) { parent::__construct($source); if ($source instanceof Project) { $this->project = $source; @@ -111,95 +107,92 @@ class BuildEvent extends EventObject { } /** - * Sets the message with details and the message priority for this event. + * Sets the message with details and the message priority for this event. * - * @param string The string message of the event - * @param integer The priority this message should have + * @param string The string message of the event + * @param integer The priority this message should have */ - function setMessage($message, $priority) { + public function setMessage($message, $priority) { $this->message = (string) $message; $this->priority = (int) $priority; } /** - * Set the exception that was the cause of this event. + * Set the exception that was the cause of this event. * - * @param Exception The exception that caused the event + * @param Exception The exception that caused the event */ - function setException($exception) { + public function setException($exception) { $this->exception = $exception; } /** - * Returns the project instance that fired this event. + * 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. + * The reference to the project instance is set by the constructor if this + * event was fired from the project class. * - * @return Project The project instance that fired this event + * @return Project The project instance that fired this event */ - function getProject() { + public function getProject() { return $this->project; } /** - * Returns the target instance that fired this event. + * 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. + * The reference to the target instance is set by the constructor if this + * event was fired from the target class. * - * @return object The target that fired this event - * @access public + * @return Target The target that fired this event */ - function getTarget() { + public function getTarget() { return $this->target; } /** - * Returns the target instance that fired this event. + * 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. + * The reference to the task instance is set by the constructor if this + * event was fired within a task. * - * @return object The task that fired this event - * @access public + * @return Task The task that fired this event */ - function getTask() { + public function getTask() { return $this->task; } /** - * Returns the logging message. This field will only be set for - * "messageLogged" events. + * Returns the logging message. This field will only be set for + * "messageLogged" events. * - * @return string The log message - * @access public + * @return string The log message */ function getMessage() { return $this->message; } /** - * Returns the priority of the logging message. This field will only - * be set for "messageLogged" events. + * Returns the priority of the logging message. This field will only + * be set for "messageLogged" events. * - * @return integer The message priority - * @access public + * @return integer The message priority */ function getPriority() { return $this->priority; } /** - * Returns the exception that was thrown, if any. - * This field will only be set for "taskFinished", "targetFinished", and - * "buildFinished" events. + * Returns the exception that was thrown, if any. + * This field will only be set for "taskFinished", "targetFinished", and + * "buildFinished" events. * - * @see BuildListener::taskFinished() - * @see BuildListener::targetFinished() - * @see BuildListener::buildFinished() + * @see BuildListener::taskFinished() + * @see BuildListener::targetFinished() + * @see BuildListener::buildFinished() + * @return Exception */ - function getException() { + public function getException() { return $this->exception; } } |