summaryrefslogtreecommitdiff
path: root/includes/debug/logger/Spi.php
blob: 51818a38ce37a835e076d49be1d3e68fd8b1eb48 (plain)
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
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

namespace MediaWiki\Logger;

/**
 * Service provider interface for \\Psr\\Log\\LoggerInterface implementation
 * libraries.
 *
 * MediaWiki can be configured to use a class implementing this interface to
 * create new \\Psr\\Log\\LoggerInterface instances via either the
 * $wgMWLoggerDefaultSpi global variable or code that constructs an instance
 * and registers it via the LoggerFactory::registerProvider() static method.
 *
 * @see \\MediaWiki\\Logger\\LoggerFactory
 * @since 1.25
 * @author Bryan Davis <bd808@wikimedia.org>
 * @copyright © 2014 Bryan Davis and Wikimedia Foundation.
 */
interface Spi {

	/**
	 * Get a logger instance.
	 *
	 * @param string $channel Logging channel
	 * @return \\Psr\\Log\\LoggerInterface Logger instance
	 */
	public function getLogger( $channel );

}