add prefix to entry and pattern parser

matthi4s · matthi4s · commit 8478afe5edef · 2026-01-21T12:36:43.000+01:00
diff --git a/src/Log/Entry.php b/src/Log/Entry.php
@@ -15,6 +15,7 @@ class Entry implements EntryInterface
     protected array $lines = [];
     protected ?LevelInterface $level = null;
     protected ?int $time = null;
+    protected ?string $prefix = null;
     protected int $iterator = 0;
 
     /**
@@ -95,6 +96,28 @@ public function getTime(): ?int
         return $this->time;
     }
 
+    /**
+     * Set the prefix
+     *
+     * @param string $prefix
+     * @return $this
+     */
+    public function setPrefix(string $prefix): static
+    {
+        $this->prefix = $prefix;
+        return $this;
+    }
+
+    /**
+     * Get the prefix
+     *
+     * @return string|null
+     */
+    public function getPrefix(): ?string
+    {
+        return $this->prefix;
+    }
+
     /**
      * Return the current element
      *
@@ -214,6 +237,7 @@ public function jsonSerialize(): array
         return [
             'level' => $this->getLevel(),
             'time' => $this->getTime(),
+            'prefix' => $this->getPrefix(),
             'lines' => $this->getLines()
         ];
     }
diff --git a/src/Parser/PatternParser.php b/src/Parser/PatternParser.php
@@ -21,8 +21,9 @@ class PatternParser extends Parser
     /**
      * Match constants, see setMatches()
      */
-    const string TIME = "time";
-    const string LEVEL = "level";
+    public const string TIME = "time";
+    public const string LEVEL = "level";
+    public const string PREFIX = "prefix";
 
     /**
      * @var class-string<EntryInterface>
@@ -172,6 +173,9 @@ protected function parseEntryMatch(Entry $entry, string $matchType, string $matc
             case static::LEVEL:
                 $entry->setLevel($this->levelClass::fromString($matchString));
                 break;
+            case static::PREFIX:
+                $entry->setPrefix($matchString);
+                break;
             default:
                 throw new InvalidArgumentException("Match type '" . $matchType . "' is not defined.");
         }
diff --git a/test/src/Log/TestPatternLog.php b/test/src/Log/TestPatternLog.php
@@ -21,8 +21,8 @@ class TestPatternLog extends AnalysableLog
     public static function getDefaultParser(): PatternParser
     {
         return (new PatternParser())
-            ->setPattern('/\[([^\]]+)\] \[[^\/]+\/([^\]]+)\].*/')
-            ->setMatches([PatternParser::TIME, PatternParser::LEVEL])
+            ->setPattern('/(\[([^\]]+)\] \[[^\/]+\/([^\]]+)\]).*/')
+            ->setMatches([PatternParser::PREFIX, PatternParser::TIME, PatternParser::LEVEL])
             ->setTimeFormat('d.m.Y H:i:s');
     }
 
diff --git a/test/tests/Analyser/PatternAnalyserTest.php b/test/tests/Analyser/PatternAnalyserTest.php
@@ -27,33 +27,33 @@ protected function getExpectedAnalysis(): Analysis
             ->addInsight((new TestPatternProblem())
                 ->setCause("ABC")
                 ->increaseCounter()
-                ->setEntry((new Entry())->setTime(2)->setLevel(Level::ERROR)
+                ->setEntry((new Entry())->setTime(2)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:02] [Log/ERROR]")
                     ->addLine(new Line(2, "[01.01.1970 00:00:02] [Log/ERROR] I have a problem with ABC"))
                 )
             )
             ->addInsight((new TestPatternProblem())
                 ->setCause("XYZ")
-                ->setEntry((new Entry())->setTime(4)->setLevel(Level::ERROR)
+                ->setEntry((new Entry())->setTime(4)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:04] [Log/ERROR]")
                     ->addLine(new Line(4, "[01.01.1970 00:00:04] [Log/ERROR] I have a problem with XYZ"))
                 )
             )
             ->addInsight((new TestPatternProblem())
                 ->setCause("DEF")
-                ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)
+                ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:06] [Log/ERROR]")
                     ->addLine(new Line(6, "[01.01.1970 00:00:06] [Log/ERROR] I have a problem with DEF"))
                     ->addLine(new Line(7, "I have a problem with GHI"))
                 )
             )
             ->addInsight((new TestPatternProblem())
                 ->setCause("GHI")
-                ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)
+                ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:06] [Log/ERROR]")
                     ->addLine(new Line(6, "[01.01.1970 00:00:06] [Log/ERROR] I have a problem with DEF"))
                     ->addLine(new Line(7, "I have a problem with GHI"))
                 )
             )
             ->addInsight((new TestPatternInformation())
                 ->setValue("v1.2.3")
-                ->setEntry((new Entry())->setTime(7)->setLevel(Level::INFO)
+                ->setEntry((new Entry())->setTime(7)->setLevel(Level::INFO)->setPrefix("[01.01.1970 00:00:07] [Log/INFO]")
                     ->addLine(new Line(8, "[01.01.1970 00:00:07] [Log/INFO] This log was generated by software v1.2.3"))
                 )
             );
diff --git a/test/tests/Log/EntryTest.php b/test/tests/Log/EntryTest.php
@@ -42,6 +42,14 @@ public function testSetGetTime(): void
         $this->assertEquals($time, $entry->getTime());
     }
 
+    public function testSetGetPrefix(): void
+    {
+        $entry = new Entry();
+        $prefix = uniqid();
+        $this->assertSame($entry, $entry->setPrefix($prefix));
+        $this->assertEquals($prefix, $entry->getPrefix());
+    }
+
     public function testKey(): void
     {
         $entry = new Entry();
diff --git a/test/tests/Parser/PatternParserTest.php b/test/tests/Parser/PatternParserTest.php
@@ -22,17 +22,17 @@ protected function getSimpleExpectedLog(): Log
     {
         return (new TestPatternLog())
             ->setLogFile(new PathLogFile(__DIR__ . '/../../data/simple.log'))
-            ->addEntry((new Entry())->setLevel(Level::INFO)->setTime(1)
+            ->addEntry((new Entry())->setLevel(Level::INFO)->setTime(1)->setPrefix("[01.01.1970 00:00:01] [Log/INFO]")
                 ->addLine(new Line(1, "[01.01.1970 00:00:01] [Log/INFO] This is the first message containing information.")))
-            ->addEntry((new Entry())->setLevel(Level::DEBUG)->setTime(2)
+            ->addEntry((new Entry())->setLevel(Level::DEBUG)->setTime(2)->setPrefix("[01.01.1970 00:00:02] [Log/DEBUG]")
                 ->addLine(new Line(2, "[01.01.1970 00:00:02] [Log/DEBUG] This is the second message containing a debug information.")))
-            ->addEntry((new Entry())->setLevel(Level::WARNING)->setTime(3)
+            ->addEntry((new Entry())->setLevel(Level::WARNING)->setTime(3)->setPrefix("[01.01.1970 00:00:03] [Log/WARN]")
                 ->addLine(new Line(3, "[01.01.1970 00:00:03] [Log/WARN] This is the third message containing a warning information.")))
-            ->addEntry((new Entry())->setLevel(Level::ERROR)->setTime(4)
+            ->addEntry((new Entry())->setLevel(Level::ERROR)->setTime(4)->setPrefix("[01.01.1970 00:00:04] [Log/ERROR]")
                 ->addLine(new Line(4, "[01.01.1970 00:00:04] [Log/ERROR] This is the third message containing an error information."))
                 ->addLine(new Line(5, "This line continues the error entry to add even more information."))
                 ->addLine(new Line(6, "This line is also part of the error entry.")))
-            ->addEntry((new Entry())->setLevel(Level::INFO)->setTime(5)
+            ->addEntry((new Entry())->setLevel(Level::INFO)->setTime(5)->setPrefix("[01.01.1970 00:00:05] [Log/INFO]")
                 ->addLine(new Line(7, "[01.01.1970 00:00:05] [Log/INFO] This is the last message of the log.")));
     }
 
@@ -46,15 +46,14 @@ public function testParse(): void
         $this->assertEquals($this->getSimpleExpectedLog(), $log);
     }
 
-
     public function testParseWithCustomParser(): void
     {
         $logFile = new PathLogFile(__DIR__ . '/../../data/simple.log');
         $log = (new TestPatternLog())->setLogFile($logFile);
 
         $patternParser = (new PatternParser())
-            ->setPattern('/\[([^\]]+)\] \[[^\/]+\/([^\]]+)\].*/')
-            ->setMatches([PatternParser::TIME, PatternParser::LEVEL])
+            ->setPattern('/(\[([^\]]+)\] \[[^\/]+\/([^\]]+)\]).*/')
+            ->setMatches([PatternParser::PREFIX, PatternParser::TIME, PatternParser::LEVEL])
             ->setTimeFormat('d.m.Y H:i:s');
         $log->parse($patternParser);
 

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ class TestPatternLog extends AnalysableLog`
`21`	`21`	`public static function getDefaultParser(): PatternParser`
`22`	`22`	`{`
`23`	`23`	`return (new PatternParser())`
`24`		`- ->setPattern('/\[([^\]]+)\] \[[^\/]+\/([^\]]+)\].*/')`
`25`		`- ->setMatches([PatternParser::TIME, PatternParser::LEVEL])`
	`24`	`+ ->setPattern('/(\[([^\]]+)\] \[[^\/]+\/([^\]]+)\]).*/')`
	`25`	`+ ->setMatches([PatternParser::PREFIX, PatternParser::TIME, PatternParser::LEVEL])`
`26`	`26`	`->setTimeFormat('d.m.Y H:i:s');`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -27,33 +27,33 @@ protected function getExpectedAnalysis(): Analysis`
`27`	`27`	`->addInsight((new TestPatternProblem())`
`28`	`28`	`->setCause("ABC")`
`29`	`29`	`->increaseCounter()`
`30`		`- ->setEntry((new Entry())->setTime(2)->setLevel(Level::ERROR)`
	`30`	`+ ->setEntry((new Entry())->setTime(2)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:02] [Log/ERROR]")`
`31`	`31`	`->addLine(new Line(2, "[01.01.1970 00:00:02] [Log/ERROR] I have a problem with ABC"))`
`32`	`32`	`)`
`33`	`33`	`)`
`34`	`34`	`->addInsight((new TestPatternProblem())`
`35`	`35`	`->setCause("XYZ")`
`36`		`- ->setEntry((new Entry())->setTime(4)->setLevel(Level::ERROR)`
	`36`	`+ ->setEntry((new Entry())->setTime(4)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:04] [Log/ERROR]")`
`37`	`37`	`->addLine(new Line(4, "[01.01.1970 00:00:04] [Log/ERROR] I have a problem with XYZ"))`
`38`	`38`	`)`
`39`	`39`	`)`
`40`	`40`	`->addInsight((new TestPatternProblem())`
`41`	`41`	`->setCause("DEF")`
`42`		`- ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)`
	`42`	`+ ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:06] [Log/ERROR]")`
`43`	`43`	`->addLine(new Line(6, "[01.01.1970 00:00:06] [Log/ERROR] I have a problem with DEF"))`
`44`	`44`	`->addLine(new Line(7, "I have a problem with GHI"))`
`45`	`45`	`)`
`46`	`46`	`)`
`47`	`47`	`->addInsight((new TestPatternProblem())`
`48`	`48`	`->setCause("GHI")`
`49`		`- ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)`
	`49`	`+ ->setEntry((new Entry())->setTime(6)->setLevel(Level::ERROR)->setPrefix("[01.01.1970 00:00:06] [Log/ERROR]")`
`50`	`50`	`->addLine(new Line(6, "[01.01.1970 00:00:06] [Log/ERROR] I have a problem with DEF"))`
`51`	`51`	`->addLine(new Line(7, "I have a problem with GHI"))`
`52`	`52`	`)`
`53`	`53`	`)`
`54`	`54`	`->addInsight((new TestPatternInformation())`
`55`	`55`	`->setValue("v1.2.3")`
`56`		`- ->setEntry((new Entry())->setTime(7)->setLevel(Level::INFO)`
	`56`	`+ ->setEntry((new Entry())->setTime(7)->setLevel(Level::INFO)->setPrefix("[01.01.1970 00:00:07] [Log/INFO]")`
`57`	`57`	`->addLine(new Line(8, "[01.01.1970 00:00:07] [Log/INFO] This log was generated by software v1.2.3"))`
`58`	`58`	`)`
`59`	`59`	`);`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,14 @@ public function testSetGetTime(): void`
`42`	`42`	`$this->assertEquals($time, $entry->getTime());`
`43`	`43`	`}`
`44`	`44`
	`45`	`+ public function testSetGetPrefix(): void`
	`46`	`+ {`
	`47`	`+ $entry = new Entry();`
	`48`	`+ $prefix = uniqid();`
	`49`	`+ $this->assertSame($entry, $entry->setPrefix($prefix));`
	`50`	`+ $this->assertEquals($prefix, $entry->getPrefix());`
	`51`	`+ }`
	`52`	`+`
`45`	`53`	`public function testKey(): void`
`46`	`54`	`{`
`47`	`55`	`$entry = new Entry();`