includes/debug/logger/Spi.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\Logger;
  22
  23 /**
  24  * Service provider interface for \Psr\Log\LoggerInterface implementation
  25  * libraries.
  26  *
  27  * MediaWiki can be configured to use a class implementing this interface to
  28  * create new \Psr\Log\LoggerInterface instances via either the
  29  * $wgMWLoggerDefaultSpi global variable or code that constructs an instance
  30  * and registers it via the LoggerFactory::registerProvider() static method.
  31  *
  32  * @see \MediaWiki\Logger\LoggerFactory
  33  * @since 1.25
  34  * @author Bryan Davis <bd808@wikimedia.org>
  35  * @copyright © 2014 Bryan Davis and Wikimedia Foundation.
  36  */
  37 interface Spi {
  38
  39         /**
  40          * Get a logger instance.
  41          *
  42          * @param string $channel Logging channel
  43          * @return \Psr\Log\LoggerInterface Logger instance
  44          */
  45         public function getLogger( $channel );
  46
  47 }