Browse Source

update method name and comment

add to test case for ConsoleLog
mtak3 6 years ago
parent
commit
1b1019169e

+ 4 - 2
src/Log/Engine/BaseLog.php

@@ -161,11 +161,13 @@ abstract class BaseLog extends AbstractLogger
     }
 
     /**
-     * Get the date.
+     * Returns date formatted according to given `dateFormat` option format.
+     *
+     * This function affects `FileLog` or` ConsoleLog` datetime information format.
      *
      * @return string
      */
-    protected function _date()
+    protected function _getFormattedDate()
     {
         return date($this->_config['dateFormat']);
     }

+ 1 - 1
src/Log/Engine/ConsoleLog.php

@@ -88,7 +88,7 @@ class ConsoleLog extends BaseLog
     public function log($level, $message, array $context = [])
     {
         $message = $this->_format($message, $context);
-        $output = $this->_date() . ' ' . ucfirst($level) . ': ' . $message;
+        $output = $this->_getFormattedDate() . ' ' . ucfirst($level) . ': ' . $message;
 
         $this->_output->write(sprintf('<%s>%s</%s>', $level, $output, $level));
     }

+ 1 - 1
src/Log/Engine/FileLog.php

@@ -119,7 +119,7 @@ class FileLog extends BaseLog
     public function log($level, $message, array $context = []): void
     {
         $message = $this->_format($message, $context);
-        $output = $this->_date() . ' ' . ucfirst($level) . ': ' . $message . "\n";
+        $output = $this->_getFormattedDate() . ' ' . ucfirst($level) . ': ' . $message . "\n";
         $filename = $this->_getFilename($level);
         if ($this->_size) {
             $this->_rotateFile($filename);

+ 19 - 0
tests/TestCase/Log/Engine/ConsoleLogTest.php

@@ -57,6 +57,7 @@ class ConsoleLogTest extends TestCase
         $fh = fopen($filename, 'r');
         $line = fgets($fh);
         $this->assertStringContainsString('Error: oh noes', $line);
+        $this->assertRegExp('/^2[0-9]{3}-[0-9]+-[0-9]+ [0-9]+:[0-9]+:[0-9]+ Error: oh noes/', $line);
     }
 
     /**
@@ -76,4 +77,22 @@ class ConsoleLogTest extends TestCase
         ]);
         $this->assertEquals(ConsoleOutput::RAW, $log->getConfig('outputAs'));
     }
+
+    /**
+     * test dateFormat option
+     *
+     * @return void
+     */
+    public function testDateFormat()
+    {
+        $filename = tempnam(sys_get_temp_dir(), 'cake_log_test');
+        $log = new ConsoleLog([
+            'stream' => $filename,
+            'dateFormat' => 'c',
+        ]);
+        $log->log('error', 'oh noes');
+        $fh = fopen($filename, 'r');
+        $line = fgets($fh);
+        $this->assertRegExp('/^2[0-9]{3}-[0-9]+-[0-9]+T[0-9]+:[0-9]+:[0-9]+\+\d{2}:\d{2} Error: oh noes/', $line);
+    }
 }

+ 1 - 1
tests/TestCase/Log/Engine/FileLogTest.php

@@ -200,7 +200,7 @@ class FileLogTest extends TestCase
     }
 
     /**
-     * test log dateFormat option
+     * test dateFormat option
      *
      * @return void
      */