includes/debug/logger/NullSpi.php

   1 <?php
   2 /**
   3  * @section LICENSE
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  */
  21
  22 /**
  23  * MWLogger service provider that creates \Psr\Log\NullLogger instances.
  24  * A NullLogger silently discards all log events sent to it.
  25  *
  26  * Usage:
  27  * @code
  28  * $wgMWLoggerDefaultSpi = array(
  29  *   'class' => 'MWLoggerNullSpi',
  30  * );
  31  * @endcode
  32  *
  33  * @see MWLogger
  34  * @since 1.25
  35  * @author Bryan Davis <bd808@wikimedia.org>
  36  * @copyright © 2014 Bryan Davis and Wikimedia Foundation.
  37  */
  38 class MWLoggerNullSpi implements MWLoggerSpi {
  39
  40         /**
  41          * @var \Psr\Log\NullLogger $singleton
  42          */
  43         protected $singleton;
  44
  45
  46         public function __construct() {
  47                 $this->singleton = new \Psr\Log\NullLogger();
  48         }
  49
  50
  51         /**
  52          * Get a logger instance.
  53          *
  54          * @param string $channel Logging channel
  55          * @return MWLogger Logger instance
  56          */
  57         public function getLogger( $channel ) {
  58                 return $this->singleton;
  59         }
  60
  61 }