MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / debug / logger / NullSpi.php

diff --git a/includes/debug/logger/NullSpi.php b/includes/debug/logger/NullSpi.php
new file mode 100644 (file)
index 0000000..4862157
--- /dev/null
+++ b/includes/debug/logger/NullSpi.php
@@ -0,0 +1,60 @@
+<?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;
+
+use Psr\Log\NullLogger;
+
+/**
+ * LoggerFactory service provider that creates \Psr\Log\NullLogger
+ * instances. A NullLogger silently discards all log events sent to it.
+ *
+ * Usage:
+ *
+ *     $wgMWLoggerDefaultSpi = [
+ *         'class' => '\\MediaWiki\\Logger\\NullSpi',
+ *     ];
+ *
+ * @see \MediaWiki\Logger\LoggerFactory
+ * @since 1.25
+ * @copyright © 2014 Wikimedia Foundation and contributors
+ */
+class NullSpi implements Spi {
+
+       /**
+        * @var \Psr\Log\NullLogger $singleton
+        */
+       protected $singleton;
+
+       public function __construct() {
+               $this->singleton = new NullLogger();
+       }
+
+       /**
+        * Get a logger instance.
+        *
+        * @param string $channel Logging channel
+        * @return \Psr\Log\NullLogger Logger instance
+        */
+       public function getLogger( $channel ) {
+               return $this->singleton;
+       }
+
+}