ErrorMessage: new flag for logging 'error' level to log

4dev/tests/Logging/CoreLibsLoggingErrorMessagesTest.php

@@ -96,7 +96,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 			'log_level' => Level::Debug,
 		]);
 		$em = new \CoreLibs\Logging\ErrorMessage($log);
-		$em->setError(
+		$em->setMessage(
 			$level,
 			$str
 		);
@@ -200,14 +200,44 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 		);
 	}
 
+	/**
+	 * Undocumented function
+	 *
+	 * @return array
+	 */
 	public function providerErrorMessageLog(): array
 	{
 		return [
+			'error, not logged' => [
+				'id' => '200',
+				'level' => 'error',
+				'str' => 'ERROR MESSAGE',
+				'message' => null,
+				'log_error' => null,
+				'expected' => '<ERROR> ERROR MESSAGE',
+			],
+			'error, logged' => [
+				'id' => '200',
+				'level' => 'error',
+				'str' => 'ERROR MESSAGE',
+				'message' => null,
+				'log_error' => true,
+				'expected' => '<ERROR> ERROR MESSAGE',
+			],
+			'error, logged, message' => [
+				'id' => '200',
+				'level' => 'error',
+				'str' => 'ERROR MESSAGE',
+				'message' => 'OTHER ERROR MESSAGE',
+				'log_error' => true,
+				'expected' => '<ERROR> OTHER ERROR MESSAGE',
+			],
 			'crash' => [
 				'id' => '300',
 				'level' => 'crash',
 				'str' => 'CRASH MESSAGE',
 				'message' => null,
+				'log_error' => null,
 				'expected' => '<ALERT> CRASH MESSAGE',
 			],
 			'crash, message' => [
@@ -215,6 +245,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 				'level' => 'crash',
 				'str' => 'CRASH MESSAGE',
 				'message' => 'OTHER CRASH MESSAGE',
+				'log_error' => null,
 				'expected' => '<ALERT> OTHER CRASH MESSAGE',
 			],
 			'abort' => [
@@ -222,6 +253,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 				'level' => 'abort',
 				'str' => 'ABORT MESSAGE',
 				'message' => null,
+				'log_error' => null,
 				'expected' => '<CRITICAL> ABORT MESSAGE',
 			],
 			'abort, message' => [
@@ -229,6 +261,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 				'level' => 'abort',
 				'str' => 'ABORT MESSAGE',
 				'message' => 'OTHER ABORT MESSAGE',
+				'log_error' => null,
 				'expected' => '<CRITICAL> OTHER ABORT MESSAGE',
 			],
 			'unknown' => [
@@ -236,6 +269,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 				'level' => 'wrong level',
 				'str' => 'WRONG LEVEL MESSAGE',
 				'message' => null,
+				'log_error' => null,
 				'expected' => '<EMERGENCY> WRONG LEVEL MESSAGE',
 			],
 			'unknown, message' => [
@@ -243,6 +277,7 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 				'level' => 'wrong level',
 				'str' => 'WRONG LEVEL MESSAGE',
 				'message' => 'OTHER WRONG LEVEL MESSAGE',
+				'log_error' => null,
 				'expected' => '<EMERGENCY> OTHER WRONG LEVEL MESSAGE',
 			],
 		];
@@ -254,10 +289,22 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 	 * @dataProvider providerErrorMessageLog
 	 * @testdox Test Log writing [$_dataName]
 	 *
+	 * @param  string      $id
+	 * @param  string      $level
+	 * @param  string      $str
+	 * @param  string|null $message
+	 * @param  bool|null   $log_error
+	 * @param  string      $expected
 	 * @return void
 	 */
-	public function testErrorMessageLog(string $id, string $level, string $str, ?string $message, string $expected)
-	{
+	public function testErrorMessageLog(
+		string $id,
+		string $level,
+		string $str,
+		?string $message,
+		?bool $log_error,
+		string $expected
+	): void {
 		$log = new \CoreLibs\Logging\Logging([
 			'log_file_id' => 'testErrorMessages',
 			'log_folder' => self::LOG_FOLDER,
@@ -269,15 +316,27 @@ final class CoreLibsLoggingErrorMessagesTest extends TestCase
 			$id,
 			$level,
 			$str,
-			message: $message
-		);
-		$file_content = file_get_contents(
-			$log->getLogFolder() . $log->getLogFile()
-		) ?: '';
-		$this->assertStringContainsString(
-			$expected,
-			$file_content
+			message: $message,
+			log_error: $log_error
 		);
+		$file_content = '';
+		if (is_file($log->getLogFolder() . $log->getLogFile())) {
+			$file_content = file_get_contents(
+				$log->getLogFolder() . $log->getLogFile()
+			) ?: '';
+		}
+		// if n
+		if ($level == 'error' && ($log_error === null || $log_error === false)) {
+			$this->assertStringNotContainsString(
+				$expected,
+				$file_content
+			);
+		} else {
+			$this->assertStringContainsString(
+				$expected,
+				$file_content
+			);
+		}
 	}
 }
 

www/admin/class_test.error_msg.php

@@ -39,7 +39,8 @@ print "FN: " . ml::fromName('Affe')->name . "<br>";
 print "NU: " . ml::fromValue(100)->name . "<br>";
 print "NU: " . ml::fromValue(1000)->name . "<br>";
 
-$em->setErrorMsg('123', 'error', 'msg this is bad');
+$em->setErrorMsg('123', 'error', 'msg this is bad, not logged');
+$em->setErrorMsg('123', 'error', 'msg this is bad, logged', log_error:true);
 $em->setErrorMsg('1000', 'info', 'This is good');
 $em->setErrorMsg('9999', 'abort', 'BAD: This is critical (abort)');
 $em->setErrorMsg('10-1000', 'wrong', 'Wrong level: This is emergency');

www/lib/CoreLibs/Logging/ErrorMessage.php

@@ -20,10 +20,21 @@ class ErrorMessage
 	/** @var \CoreLibs\Logging\Logging $log */
 	public \CoreLibs\Logging\Logging $log;
 
+	/** @var bool $log_error global flag to log error level message */
+	private bool $log_error = false;
+
+	/**
+	 * init ErrorMessage
+	 *
+	 * @param  \CoreLibs\Logging\Logging $log
+	 * @param  bool                      $log_error [=false]
+	 */
 	public function __construct(
-		\CoreLibs\Logging\Logging $log
+		\CoreLibs\Logging\Logging $log,
+		bool $log_error = false
 	) {
 		$this->log = $log;
+		$this->log_error = $log_error;
 	}
 
 	/**
@@ -50,6 +61,8 @@ class ErrorMessage
 	 *                                  highlight points for field highlights
 	 * @param  string|null   $message   If abort/crash, non localized $str
 	 * @param  array<mixed>  $context   Additionl info for abort/crash messages
+	 * @param  bool|null     $log_error [=null] log level 'error' to error, if null use global,
+	 *                                  else set for this call only
 	 */
 	public function setErrorMsg(
 		string $error_id,
@@ -59,7 +72,11 @@ class ErrorMessage
 		array $highlight = [],
 		?string $message = null,
 		array $context = [],
+		?bool $log_error = null,
 	): void {
+		if ($log_error === null) {
+			$log_error = $this->log_error;
+		}
 		$original_level = $level;
 		$level = MessageLevel::fromName($level)->name;
 		// if not string set, write message string if set, else level/error id
@@ -75,6 +92,14 @@ class ErrorMessage
 		];
 		// write to log for abort/crash
 		switch ($level) {
+			case 'error':
+				if ($log_error) {
+					$this->log->error($message ?? $str, array_merge([
+						'id' => $error_id,
+						'level' => $original_level,
+					], $context));
+				}
+				break;
 			case 'abort':
 				$this->log->critical($message ?? $str, array_merge([
 					'id' => $error_id,
@@ -109,9 +134,10 @@ class ErrorMessage
 	 *                                  highlight points for field highlights
 	 * @param  string|null   $message   If abort/crash, non localized $str
 	 * @param  array<mixed>  $context   Additionl info for abort/crash messages
-	 * @deprecated 9.7 Use setError instead
+	 * @param  bool|null     $log_error [=null] log level 'error' to error, if null use global,
+	 *                                  else set for this call only
 	 */
-	public function setErrorMsgLevel(
+	public function setMessage(
 		string $level,
 		string $str,
 		?string $error_id = null,
@@ -119,34 +145,9 @@ class ErrorMessage
 		array $highlight = [],
 		?string $message = null,
 		array $context = [],
+		?bool $log_error = null,
 	): void {
-		$this->setErrorMsg($error_id ?? '', $level, $str, $target, $highlight, $message, $context);
-	}
-
-	/**
-	 * pushes new error message into the error_str array
-	 * Note, the parameter order is different and does not need an error id
-	 * This is for backend alerts
-	 *
-	 * @param  string        $level     error level (ok/warn/info/error)
-	 * @param  string        $str       error string
-	 * @param  string|null   $error_id  optional error id for precise error lookup
-	 * @param  string        $target    Alternate id name for output target on frontend
-	 * @param  array<string> $highlight Any additional error data as error OR
-	 *                                  highlight points for field highlights
-	 * @param  string|null   $message   If abort/crash, non localized $str
-	 * @param  array<mixed>  $context   Additionl info for abort/crash messages
-	 */
-	public function setError(
-		string $level,
-		string $str,
-		?string $error_id = null,
-		string $target = '',
-		array $highlight = [],
-		?string $message = null,
-		array $context = [],
-	): void {
-		$this->setErrorMsg($error_id ?? '', $level, $str, $target, $highlight, $message, $context);
+		$this->setErrorMsg($error_id ?? '', $level, $str, $target, $highlight, $message, $context, $log_error);
 	}
 
 	// *********************************************************************
@@ -189,6 +190,31 @@ class ErrorMessage
 			'highlight' => [],
 		];
 	}
+
+	// *********************************************************************
+	// FLAG SETTERS
+	// *********************************************************************
+
+	/**
+	 * Set the log error flag
+	 *
+	 * @param  bool $flag True to log level error too, False for do not (Default)
+	 * @return void
+	 */
+	public function setFlagLogError(bool $flag): void
+	{
+		$this->log_error = $flag;
+	}
+
+	/**
+	 * Get the current log error flag
+	 *
+	 * @return bool
+	 */
+	public function getFlagLogError(): bool
+	{
+		return $this->log_error;
+	}
 }
 
 // __END__

www/lib/CoreLibs/Logging/Logger/MessageLevel.php

@@ -46,6 +46,39 @@ enum MessageLevel: int
 	{
 		return self::tryFrom($value) ?? self::unknown;
 	}
+
+	/**
+	 * Returns true if the passed $level is higher or equal to $this
+	 *
+	 * @param  MessageLevel $level
+	 * @return bool
+	 */
+	public function includes(MessageLevel $level): bool
+	{
+		return $this->value <= $level->value;
+	}
+
+	/**
+	 * If level is higher than set one
+	 *
+	 * @param  MessageLevel $level
+	 * @return bool
+	 */
+	public function isHigherThan(MessageLevel $level): bool
+	{
+		return $this->value > $level->value;
+	}
+
+	/**
+	 * if level is lower than set one
+	 *
+	 * @param  MessageLevel $level
+	 * @return bool
+	 */
+	public function isLowerThan(MessageLevel $level): bool
+	{
+		return $this->value < $level->value;
+	}
 }
 
 // __END__