rex_log_file: factory-Methode (#5957)

redaxo · Feb 27, 2024 · 66d68b3 · 66d68b3
1 parent 33bb439
commit 66d68b3
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 10 deletions.
diff --git a/.tools/phpstan/baseline.neon b/.tools/phpstan/baseline.neon
@@ -2545,6 +2545,11 @@ parameters:
 			count: 1
 			path: ../../redaxo/src/core/lib/util/formatter.php
 
+		-
+			message: "#^Method rex_log_file\\:\\:callFactoryClass\\(\\) has parameter \\$arguments with no value type specified in iterable type array\\.$#"
+			count: 1
+			path: ../../redaxo/src/core/lib/util/log_file.php
+
 		-
 			message: "#^Method rex_logger\\:\\:callFactoryClass\\(\\) has parameter \\$arguments with no value type specified in iterable type array\\.$#"
 			count: 1

diff --git a/redaxo/src/addons/cronjob/lib/manager.php b/redaxo/src/addons/cronjob/lib/manager.php
@@ -138,7 +138,7 @@ public function log($success, $message)
             $environment = rex::getEnvironment();
         }
 
-        $log = new rex_log_file(rex_path::log('cronjob.log'), 2_000_000);
+        $log = rex_log_file::factory(rex_path::log('cronjob.log'), 2_000_000);
         $data = [
             $success ? 'SUCCESS' : 'ERROR',
             $this->id ?: '--',

diff --git a/redaxo/src/addons/cronjob/package.yml b/redaxo/src/addons/cronjob/package.yml
@@ -19,7 +19,7 @@ pages:
 
 requires:
     php: '>=8.1'
-    redaxo: ^5.16.0
+    redaxo: ^5.17.0-dev
 
 console_commands:
     cronjob:run: rex_command_cronjob_run
diff --git a/redaxo/src/addons/cronjob/pages/log.php b/redaxo/src/addons/cronjob/pages/log.php
@@ -42,7 +42,7 @@
 
 $formElements = [];
 
-$file = new rex_log_file($logFile);
+$file = rex_log_file::factory($logFile);
 
 /** @var rex_log_entry $entry */
 foreach (new LimitIterator($file, 0, 100) as $entry) {

diff --git a/redaxo/src/addons/phpmailer/lib/mailer.php b/redaxo/src/addons/phpmailer/lib/mailer.php
@@ -178,7 +178,7 @@ private function log(string $success): void
             $replytos = implode(', ', array_column($this->getReplyToAddresses(), 0));
         }
 
-        $log = new rex_log_file(self::logFile(), 2_000_000);
+        $log = rex_log_file::factory(self::logFile(), 2_000_000);
         $data = [
             $success,
             $this->From . ($replytos ? '; reply-to: ' . $replytos : ''),
@@ -255,7 +255,7 @@ public static function errorMail(): void
             return;
         }
 
-        $file = new rex_log_file($logFile);
+        $file = rex_log_file::factory($logFile);
 
         $logevent = false;
 

diff --git a/redaxo/src/addons/phpmailer/package.yml b/redaxo/src/addons/phpmailer/package.yml
@@ -21,7 +21,7 @@ pages:
 
 requires:
     php: '>=8.1'
-    redaxo: ^5.13.0
+    redaxo: ^5.17.0-dev
 
 default_config:
     from: ''

diff --git a/redaxo/src/addons/phpmailer/pages/log.php b/redaxo/src/addons/phpmailer/pages/log.php
@@ -34,7 +34,7 @@
                 </thead>
                 <tbody>';
 
-$file = new rex_log_file($logFile);
+$file = rex_log_file::factory($logFile);
 foreach (new LimitIterator($file, 0, 30) as $entry) {
     $data = $entry->getData();
     $class = 'ERROR' == trim($data[0]) ? 'rex-state-error' : 'rex-mailer-log-ok';

diff --git a/redaxo/src/core/boot.php b/redaxo/src/core/boot.php
@@ -90,7 +90,7 @@
 require_once rex_path::core('functions/function_rex_other.php');
 
 // ----------------- VERSION
-rex::setProperty('version', '5.16.1');
+rex::setProperty('version', '5.17.0-dev');
 
 $cacheFile = rex_path::coreCache('config.yml.cache');
 $configFile = rex_path::coreData('config.yml');

diff --git a/redaxo/src/core/lib/util/log_file.php b/redaxo/src/core/lib/util/log_file.php
@@ -10,6 +10,8 @@
  */
 class rex_log_file implements Iterator
 {
+    use rex_factory_trait;
+
     /** @var string */
     private $path;
 
@@ -40,6 +42,7 @@ class rex_log_file implements Iterator
     /**
      * @param string $path File path
      * @param int|null $maxFileSize Maximum file size
+     * @deprecated since 5.17.0, use `rex_log_file::factory` instead
      */
     public function __construct($path, $maxFileSize = null)
     {
@@ -53,6 +56,12 @@ public function __construct($path, $maxFileSize = null)
         $this->file = fopen($path, 'a+');
     }
 
+    public static function factory(string $path, ?int $maxFileSize = null): static
+    {
+        $class = static::getFactoryClass();
+        return new $class($path, $maxFileSize);
+    }
+
     /**
      * Adds a log entry.
      *

diff --git a/redaxo/src/core/lib/util/logger.php b/redaxo/src/core/lib/util/logger.php
@@ -137,7 +137,7 @@ public static function open()
     {
         // check if already opened
         if (!self::$file) {
-            self::$file = new rex_log_file(self::getPath(), 2_000_000);
+            self::$file = rex_log_file::factory(self::getPath(), 2_000_000);
         }
     }
 

diff --git a/redaxo/src/core/pages/system.log.redaxo.php b/redaxo/src/core/pages/system.log.redaxo.php
@@ -45,7 +45,7 @@
 
 $editor = rex_editor::factory();
 
-$file = new rex_log_file($logFile);
+$file = rex_log_file::factory($logFile);
 foreach (new LimitIterator($file, 0, 100) as $entry) {
     /** @var rex_log_entry $entry */
     $data = $entry->getData();