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