test: add handlers for different levels

Author: Greg Bowler

src/LogConfig.php

@@ -5,14 +5,35 @@
 use Gt\Logger\LogHandler\StdOutHandler;
 
 class LogConfig {
-	/** @var LogHandler[] */
-	private static array $handlers;
+	/** @var array<LogHandler> */
+	private static array $handlers = [];
+	/** @var array<string> */
+	private static array $handlerLevels = [];
+
 	private static StdOutHandler $defaultHandler;
+	private static string $defaultHandlerLevel = LogLevel::DEBUG;
 
 	/** @return LogHandler[] */
-	public static function getHandlers():array {
+	public static function getHandlers(
+		string $logLevel = LogLevel::DEBUG
+	):array {
 		self::ensureAtLeastOneHandler();
-		return self::$handlers;
+		$logLevel = strtoupper($logLevel);
+		$logLevelIndex = array_flip(LogLevel::ALL_LEVELS)[$logLevel];
+
+		$handlerArray = [];
+		foreach(self::$handlers as $i => $handler) {
+			$handlerLevel = strtoupper(self::$handlerLevels[$i]);
+			$handlerLevelIndex = array_flip(LogLevel::ALL_LEVELS)[$handlerLevel];
+
+			if($handlerLevelIndex < $logLevelIndex) {
+				continue;
+			}
+
+			array_push($handlerArray, $handler);
+		}
+
+		return $handlerArray;
 	}
 
 	public static function getDefaultHandler():StdOutHandler {
@@ -23,13 +44,23 @@ public static function getDefaultHandler():StdOutHandler {
 		return self::$defaultHandler;
 	}
 
+	public static function addHandler(LogHandler $handler, string $logLevel = null):void {
+		array_push(self::$handlers, $handler);
+		array_push(self::$handlerLevels, $logLevel ?? self::$defaultHandlerLevel);
+	}
+
 	private static function ensureAtLeastOneHandler():void {
 		if(!isset(self::$handlers)) {
 			self::$handlers = array();
 			array_push(
 				self::$handlers,
 				self::getDefaultHandler()
 			);
+			self::$handlerLevels = array();
+			array_push(
+				self::$handlerLevels,
+				self::$defaultHandlerLevel
+			);
 		}
 	}
-}
+}

src/LogHandler/StreamHandler.php

@@ -0,0 +1,10 @@
+<?php
+namespace Gt\Logger\LogHandler;
+
+/**
+ * As a file handler can easily open and write to a stream, this class currently
+ * has no functionality of its own, but it's been stubbed out here to make it
+ * easy in the future to add features such as stream filters and sockets.
+ */
+class StreamHandler extends FileHandler {
+}

test/phpunit/LogConfigTest.php

@@ -0,0 +1,45 @@
+<?php
+namespace Gt\Logger\Test;
+
+use _HumbugBox373c0874430e\Psr\Log\LogLevel;
+use Gt\Logger\LogConfig;
+use Gt\Logger\LogHandler\FileHandler;
+use Gt\Logger\LogHandler\StdOutHandler;
+use PHPUnit\Framework\TestCase;
+
+class LogConfigTest extends TestCase {
+	public function testGetHandlers_returnsDefaultWhenEmpty():void {
+		$handlerList = LogConfig::getHandlers();
+		self::assertCount(1, $handlerList);
+		self::assertInstanceOf(StdOutHandler::class, $handlerList[0]);
+	}
+
+	public function testGetHandlers_multipleAdded():void {
+		$handler1 = self::createMock(FileHandler::class);
+		$handler2 = self::createMock(FileHandler::class);
+		$handler3 = self::createMock(FileHandler::class);
+		LogConfig::addHandler($handler1);
+		LogConfig::addHandler($handler2);
+		LogConfig::addHandler($handler3);
+
+		self::assertCount(3, LogConfig::getHandlers());
+	}
+
+	public function testGetHandlers_addWithDifferentLevels():void {
+		$handler1 = self::createMock(FileHandler::class);
+		$handler2 = self::createMock(FileHandler::class);
+		$handler3 = self::createMock(FileHandler::class);
+		LogConfig::addHandler($handler1, LogLevel::ERROR);
+		LogConfig::addHandler($handler2, LogLevel::DEBUG);
+		LogConfig::addHandler($handler3, LogLevel::EMERGENCY);
+
+		$handlersAll = LogConfig::getHandlers();
+		$handlersDebug = LogConfig::getHandlers(LogLevel::DEBUG);
+		$handlersError = LogConfig::getHandlers(LogLevel::ERROR);
+		$handlersEmergency = LogConfig::getHandlers(LogLevel::EMERGENCY);
+		self::assertCount(3, $handlersAll);
+		self::assertCount(3, $handlersDebug);
+		self::assertCount(2, $handlersError);
+		self::assertCount(1, $handlersEmergency);
+	}
+}