1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
/*
* $Id: BuildEvent.php,v 1.10 2005/12/22 22:44:46 hlellelid Exp $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://phing.info>.
*/
require_once 'phing/system/lang/EventObject.php';
/**
* Encapsulates a build specific event.
*
* <p>We have three sources of events all handled by this class:
*
* <ul>
* <li>Project level events</li>
* <li>Target level events</li>
* <li>Task level events</li>
* </ul>
*
* <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 <andi@binarycloud.com>
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.10 $
* @package phing
*/
class BuildEvent extends EventObject {
/**
* A reference to the project
* @var Project
*/
protected $project;
/**
* A reference to the target
* @var Target
*/
protected $target;
/**
* A reference to the task
*
* @var Task
*/
protected $task;
/**
* The message of this event, if the event is a message
* @var string
* @access private
*/
protected $message = null;
/**
* The priority of the message
*
* @var string
* @see $message
* @access private
*/
protected $priority = PROJECT_MSG_VERBOSE;
/**
* The execption that caused the event, if any
*
* @var object
* @access private
*/
protected $exception = null;
/**
* Construct a BuildEvent for a project, task or target source event
*
* @param object project the project that emitted the event.
* @access public
*/
function __construct($source) {
parent::__construct($source);
if ($source instanceof Project) {
$this->project = $source;
$this->target = null;
$this->task = null;
} elseif ($source instanceof Target) {
$this->project = $source->getProject();
$this->target = $source;
$this->task = null;
} elseif ($source instanceof Task) {
$this->project = $source->getProject();
$this->target = $source->getOwningTarget();
$this->task = $source;
} else {
throw new Exception("Can not construct BuildEvent, unknown source given.");
}
}
/**
* 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
*/
function setMessage($message, $priority) {
$this->message = (string) $message;
$this->priority = (int) $priority;
}
/**
* Set the exception that was the cause of this event.
*
* @param Exception The exception that caused the event
*/
function setException($exception) {
$this->exception = $exception;
}
/**
* 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.
*
* @return Project The project instance that fired this event
*/
function getProject() {
return $this->project;
}
/**
* 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.
*
* @return object The target that fired this event
* @access public
*/
function getTarget() {
return $this->target;
}
/**
* 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.
*
* @return object The task that fired this event
* @access public
*/
function getTask() {
return $this->task;
}
/**
* Returns the logging message. This field will only be set for
* "messageLogged" events.
*
* @return string The log message
* @access public
*/
function getMessage() {
return $this->message;
}
/**
* Returns the priority of the logging message. This field will only
* be set for "messageLogged" events.
*
* @return integer The message priority
* @access public
*/
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.
*
* @see BuildListener::taskFinished()
* @see BuildListener::targetFinished()
* @see BuildListener::buildFinished()
*/
function getException() {
return $this->exception;
}
}
|
