includes/debug/logger/NullSpi.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 use Psr\Log\NullLogger;
  24
  25 /**
  26  * LoggerFactory service provider that creates \\Psr\\Log\\NullLogger
  27  * instances. A NullLogger silently discards all log events sent to it.
  28  *
  29  * Usage:
  30  * @code
  31  * $wgMWLoggerDefaultSpi = array(
  32  *   'class' => '\\MediaWiki\\Logger\\NullSpi',
  33  * );
  34  * @endcode
  35  *
  36  * @see \\MediaWiki\\Logger\\LoggerFactory
  37  * @since 1.25
  38  * @author Bryan Davis <bd808@wikimedia.org>
  39  * @copyright © 2014 Bryan Davis and Wikimedia Foundation.
  40  */
  41 class NullSpi implements Spi {
  42
  43         /**
  44          * @var \\Psr\\Log\\NullLogger $singleton
  45          */
  46         protected $singleton;
  47
  48
  49         public function __construct() {
  50                 $this->singleton = new NullLogger();
  51         }
  52
  53
  54         /**
  55          * Get a logger instance.
  56          *
  57          * @param string $channel Logging channel
  58          * @return \\Psr\\Log\\NullLogger Logger instance
  59          */
  60         public function getLogger( $channel ) {
  61                 return $this->singleton;
  62         }
  63
  64 }