1: <?php
 2: 
 3: namespace Alpha\Util\Logging;
 4: 
 5: /**
 6:  * Interface that defines the methods required for a logging provider.
 7:  *
 8:  * @since 2.0
 9:  *
10:  * @author John Collins <dev@alphaframework.org>
11:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
12:  * @copyright Copyright (c) 2015, John Collins (founder of Alpha Framework).
13:  * All rights reserved.
14:  *
15:  * <pre>
16:  * Redistribution and use in source and binary forms, with or
17:  * without modification, are permitted provided that the
18:  * following conditions are met:
19:  *
20:  * * Redistributions of source code must retain the above
21:  *   copyright notice, this list of conditions and the
22:  *   following disclaimer.
23:  * * Redistributions in binary form must reproduce the above
24:  *   copyright notice, this list of conditions and the
25:  *   following disclaimer in the documentation and/or other
26:  *   materials provided with the distribution.
27:  * * Neither the name of the Alpha Framework nor the names
28:  *   of its contributors may be used to endorse or promote
29:  *   products derived from this software without specific
30:  *   prior written permission.
31:  *
32:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
33:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
34:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
35:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
37:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
40:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
42:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
43:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
44:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45:  * </pre>
46:  */
47: interface LogProviderInterface
48: {
49:     /**
50:      * Writes a line of data to the log.
51:      *
52:      * $param array $line
53:      *
54:      * @since 2.0
55:      */
56:     public function writeLine($line);
57: 
58:     /**
59:      * Renders a log as a HTML table.
60:      *
61:      * @param array $cols The headings to use when rendering the log.
62:      *
63:      * @return string
64:      *
65:      * @since 2.0
66:      */
67:     public function renderLog($cols);
68: }
69: