| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id: BuildLogger.php 147 2007-02-06 20:32:22Z hans $
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information please see
|
|
|
19 |
* <http://phing.info>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
require_once 'phing/BuildListener.php';
|
|
|
23 |
|
|
|
24 |
/**
|
|
|
25 |
* Interface for build loggers.
|
|
|
26 |
*
|
|
|
27 |
* Build loggers are build listeners but with some additional functionality:
|
|
|
28 |
* - They can be configured with a log level (below which they will ignore messages)
|
|
|
29 |
* - They have error and output streams
|
|
|
30 |
*
|
|
|
31 |
* Classes that implement a listener must implement this interface.
|
|
|
32 |
*
|
|
|
33 |
* @author Hans Lellelid <hans@xmpl.org>
|
|
|
34 |
* @version $Revision: 1.6 $
|
|
|
35 |
* @see BuildEvent
|
|
|
36 |
* @see Project::addBuildListener()
|
|
|
37 |
* @package phing
|
|
|
38 |
*/
|
|
|
39 |
interface BuildLogger extends BuildListener {
|
|
|
40 |
|
|
|
41 |
/**
|
|
|
42 |
* Sets the min log level that this logger should respect.
|
|
|
43 |
*
|
|
|
44 |
* Messages below this level are ignored.
|
|
|
45 |
*
|
|
|
46 |
* Constants for the message levels are in Project.php. The order of
|
|
|
47 |
* the levels, from least to most verbose, is:
|
|
|
48 |
* - Project::MSG_ERR
|
|
|
49 |
* - Project::MSG_WARN
|
|
|
50 |
* - Project::MSG_INFO
|
|
|
51 |
* - Project::MSG_VERBOSE
|
|
|
52 |
* - Project::MSG_DEBUG
|
|
|
53 |
*
|
|
|
54 |
* @param int $level The log level integer (e.g. Project::MSG_VERBOSE, etc.).
|
|
|
55 |
*/
|
|
|
56 |
public function setMessageOutputLevel($level);
|
|
|
57 |
|
|
|
58 |
/**
|
|
|
59 |
* Sets the standard output stream to use.
|
|
|
60 |
* @param OutputStream $output Configured output stream (e.g. STDOUT) for standard output.
|
|
|
61 |
*/
|
|
|
62 |
public function setOutputStream(OutputStream $output);
|
|
|
63 |
|
|
|
64 |
/**
|
|
|
65 |
* Sets the output stream to use for errors.
|
|
|
66 |
* @param OutputStream $err Configured output stream (e.g. STDERR) for errors.
|
|
|
67 |
*/
|
|
|
68 |
public function setErrorStream(OutputStream $err);
|
|
|
69 |
|
|
|
70 |
}
|