Merge branch '4.next' into 5.x

psalm-baseline.xml

@@ -40,6 +40,52 @@
       <code>$request</code>
     </ArgumentTypeCoercion>
   </file>
+  <file src="src/Database/Connection.php">
+    <DeprecatedMethod occurrences="1">
+      <code>supportsDynamicConstraints</code>
+    </DeprecatedMethod>
+  </file>
+  <file src="src/Database/Driver.php">
+    <InvalidScalarArgument occurrences="2">
+      <code>$value</code>
+      <code>$value</code>
+    </InvalidScalarArgument>
+  </file>
+  <file src="src/Database/Expression/QueryExpression.php">
+    <DeprecatedClass occurrences="1">
+      <code>new CaseExpression($conditions, $values, $types)</code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Database/Schema/MysqlSchemaDialect.php">
+    <NonInvariantDocblockPropertyType occurrences="1">
+      <code>$_driver</code>
+    </NonInvariantDocblockPropertyType>
+  </file>
+  <file src="src/Database/Statement/PDOStatement.php">
+    <NonInvariantDocblockPropertyType occurrences="1">
+      <code>$_statement</code>
+    </NonInvariantDocblockPropertyType>
+  </file>
+  <file src="src/Database/Type/DateTimeType.php">
+    <DeprecatedClass occurrences="1">
+      <code>Time::class</code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Database/Type/DateType.php">
+    <DeprecatedClass occurrences="1">
+      <code>Date::class</code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Datasource/ModelAwareTrait.php">
+    <DeprecatedClass occurrences="1">
+      <code>$this</code>
+    </DeprecatedClass>
+    <DeprecatedProperty occurrences="3">
+      <code>$this-&gt;modelClass</code>
+      <code>$this-&gt;modelClass</code>
+      <code>$this-&gt;modelClass</code>
+    </DeprecatedProperty>
+  </file>
   <file src="src/Http/BaseApplication.php">
     <ArgumentTypeCoercion occurrences="1">
       <code>$request</code>

src/Error/Debugger.php

@@ -826,9 +826,12 @@ class Debugger
      * Get the output format for Debugger error rendering.
      *
      * @return string Returns the current format when getting.
+     * @deprecated 4.4.0 Update your application so use ErrorTrap instead.
      */
     public static function getOutputFormat(): string
     {
+        deprecationWarning('Debugger::getOutputFormat() is deprecated.');
+
         return Debugger::getInstance()->_outputFormat;
     }
 
@@ -838,9 +841,11 @@ class Debugger
      * @param string $format The format you want errors to be output as.
      * @return void
      * @throws \InvalidArgumentException When choosing a format that doesn't exist.
+     * @deprecated 4.4.0 Update your application so use ErrorTrap instead.
      */
     public static function setOutputFormat(string $format): void
     {
+        deprecationWarning('Debugger::setOutputFormat() is deprecated.');
         $self = Debugger::getInstance();
 
         if (!isset($self->_templates[$format])) {
@@ -891,9 +896,11 @@ class Debugger
      *    straight HTML output, or 'txt' for unformatted text.
      * @param array $strings Template strings, or a callback to be used for the output format.
      * @return array The resulting format string set.
+     * @deprecated 4.4.0 Update your application so use ErrorTrap instead.
      */
     public static function addFormat(string $format, array $strings): array
     {
+        deprecationWarning('Debugger::addFormat() is deprecated.');
         $self = Debugger::getInstance();
         if (isset($self->_templates[$format])) {
             if (isset($strings['links'])) {
@@ -918,9 +925,11 @@ class Debugger
      * @param string $name The alias for the the renderer.
      * @param class-string<\Cake\Error\ErrorRendererInterface> $class The classname of the renderer to use.
      * @return void
+     * @deprecated 4.4.0 Update your application so use ErrorTrap instead.
      */
     public static function addRenderer(string $name, string $class): void
     {
+        deprecationWarning('Debugger::addRenderer() is deprecated.');
         if (!in_array(ErrorRendererInterface::class, class_implements($class))) {
             throw new InvalidArgumentException(
                 'Invalid renderer class. $class must implement ' . ErrorRendererInterface::class
@@ -935,6 +944,7 @@ class Debugger
      *
      * @param array $data Data to output.
      * @return void
+     * @deprecated 4.4.0 Update your application so use ErrorTrap instead.
      */
     public function outputError(array $data): void
     {

tests/TestCase/Error/DebuggerTest.php

@@ -135,8 +135,10 @@ class DebuggerTest extends TestCase
      */
     public function testSetOutputFormat(): void
     {
-        Debugger::setOutputFormat('html');
-        $this->assertSame('html', Debugger::getOutputFormat());
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('html');
+            $this->assertSame('html', Debugger::getOutputFormat());
+        });
     }
 
     /**
@@ -144,8 +146,10 @@ class DebuggerTest extends TestCase
      */
     public function testGetSetOutputFormat(): void
     {
-        Debugger::setOutputFormat('html');
-        $this->assertSame('html', Debugger::getOutputFormat());
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('html');
+            $this->assertSame('html', Debugger::getOutputFormat());
+        });
     }
 
     /**
@@ -154,7 +158,9 @@ class DebuggerTest extends TestCase
     public function testSetOutputAsException(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        Debugger::setOutputFormat('Invalid junk');
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('Invalid junk');
+        });
     }
 
     /**
@@ -162,18 +168,20 @@ class DebuggerTest extends TestCase
      */
     public function testOutputErrorDescriptionEncoding(): void
     {
-        Debugger::setOutputFormat('html');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $debugger->outputError([
-            'error' => 'Notice',
-            'code' => E_NOTICE,
-            'level' => E_NOTICE,
-            'description' => 'Undefined index <script>alert(1)</script>',
-            'file' => __FILE__,
-            'line' => __LINE__,
-        ]);
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('html');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $debugger->outputError([
+                'error' => 'Notice',
+                'code' => E_NOTICE,
+                'level' => E_NOTICE,
+                'description' => 'Undefined index <script>alert(1)</script>',
+                'file' => __FILE__,
+                'line' => __LINE__,
+            ]);
+        });
         $result = ob_get_clean();
         $this->assertStringContainsString('&lt;script&gt;', $result);
         $this->assertStringNotContainsString('<script>', $result);
@@ -185,7 +193,9 @@ class DebuggerTest extends TestCase
     public function testAddRendererInvalid(): void
     {
         $this->expectException(InvalidArgumentException::class);
-        Debugger::addRenderer('test', stdClass::class);
+        $this->deprecated(function () {
+            Debugger::addRenderer('test', stdClass::class);
+        });
     }
 
     /**
@@ -193,26 +203,29 @@ class DebuggerTest extends TestCase
      */
     public function testAddOutputFormatOverwrite(): void
     {
-        Debugger::addRenderer('test', HtmlErrorRenderer::class);
-        Debugger::addFormat('test', [
-            'error' => '{:description} : {:path}, line {:line}',
-        ]);
-        Debugger::setOutputFormat('test');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $data = [
-            'error' => 'Notice',
-            'code' => E_NOTICE,
-            'level' => E_NOTICE,
-            'description' => 'Oh no!',
-            'file' => __FILE__,
-            'line' => __LINE__,
-        ];
-        $debugger->outputError($data);
-        $result = ob_get_clean();
-        $this->assertStringContainsString('Oh no! :', $result);
-        $this->assertStringContainsString(", line {$data['line']}", $result);
+        $this->deprecated(function () {
+            Debugger::addRenderer('test', HtmlErrorRenderer::class);
+            Debugger::addFormat('test', [
+                'error' => '{:description} : {:path}, line {:line}',
+            ]);
+            Debugger::setOutputFormat('test');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $data = [
+                'error' => 'Notice',
+                'code' => E_NOTICE,
+                'level' => E_NOTICE,
+                'description' => 'Oh no!',
+                'file' => __FILE__,
+                'line' => __LINE__,
+            ];
+            $debugger->outputError($data);
+
+            $result = ob_get_clean();
+            $this->assertStringContainsString('Oh no! :', $result);
+            $this->assertStringContainsString(", line {$data['line']}", $result);
+        });
     }
 
     /**
@@ -220,19 +233,21 @@ class DebuggerTest extends TestCase
      */
     public function testOutputErrorLineHighlight(): void
     {
-        Debugger::setOutputFormat('js');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $data = [
-            'level' => E_NOTICE,
-            'code' => E_NOTICE,
-            'file' => __FILE__,
-            'line' => __LINE__,
-            'description' => 'Error description',
-            'start' => 1,
-        ];
-        $debugger->outputError($data);
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('js');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $data = [
+                'level' => E_NOTICE,
+                'code' => E_NOTICE,
+                'file' => __FILE__,
+                'line' => __LINE__,
+                'description' => 'Error description',
+                'start' => 1,
+            ];
+            $debugger->outputError($data);
+        });
         $result = ob_get_clean();
 
         $this->assertMatchesRegularExpression('#^\<span class\="code\-highlight"\>.*__LINE__.*\</span\>$#m', $result);
@@ -243,26 +258,28 @@ class DebuggerTest extends TestCase
      */
     public function testOutputErrorText(): void
     {
-        Debugger::setOutputFormat('txt');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $data = [
-            'level' => E_NOTICE,
-            'code' => E_NOTICE,
-            'file' => __FILE__,
-            'line' => __LINE__,
-            'description' => 'Error description',
-            'start' => 1,
-        ];
-        $debugger->outputError($data);
-        $result = ob_get_clean();
-
-        $this->assertStringContainsString('notice: 8 :: Error description', $result);
-        $this->assertStringContainsString("on line {$data['line']} of {$data['file']}", $result);
-        $this->assertStringContainsString('Trace:', $result);
-        $this->assertStringContainsString('Cake\Test\TestCase\Error\DebuggerTest::testOutputErrorText()', $result);
-        $this->assertStringContainsString('[main]', $result);
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('txt');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $data = [
+                'level' => E_NOTICE,
+                'code' => E_NOTICE,
+                'file' => __FILE__,
+                'line' => __LINE__,
+                'description' => 'Error description',
+                'start' => 1,
+            ];
+            $debugger->outputError($data);
+            $result = ob_get_clean();
+
+            $this->assertStringContainsString('notice: 8 :: Error description', $result);
+            $this->assertStringContainsString("on line {$data['line']} of {$data['file']}", $result);
+            $this->assertStringContainsString('Trace:', $result);
+            $this->assertStringContainsString('Cake\Test\TestCase\Error\DebuggerTest::testOutputErrorText()', $result);
+            $this->assertStringContainsString('[main]', $result);
+        });
     }
 
     /**
@@ -270,35 +287,37 @@ class DebuggerTest extends TestCase
      */
     public function testOutputErrorLog(): void
     {
-        Debugger::setOutputFormat('log');
-        Log::setConfig('array', ['engine' => 'Array']);
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $data = [
-            'level' => E_NOTICE,
-            'code' => E_NOTICE,
-            'file' => __FILE__,
-            'line' => __LINE__,
-            'description' => 'Error description',
-            'start' => 1,
-        ];
-        $debugger->outputError($data);
-        $output = ob_get_clean();
-        /** @var \Cake\Log\Engine\ArrayLog $logger */
-        $logger = Log::engine('array');
-        $logs = $logger->read();
-
-        $this->assertSame('', $output);
-        $this->assertCount(1, $logs);
-        // This is silly but that's how it works currently.
-        $this->assertStringContainsString("debug: \nCake\Error\Debugger::outputError()", $logs[0]);
-
-        $this->assertStringContainsString("'file' => '{$data['file']}'", $logs[0]);
-        $this->assertStringContainsString("'line' => (int) {$data['line']}", $logs[0]);
-        $this->assertStringContainsString("'trace' => ", $logs[0]);
-        $this->assertStringContainsString("'description' => 'Error description'", $logs[0]);
-        $this->assertStringContainsString('DebuggerTest::testOutputErrorLog()', $logs[0]);
+        $this->deprecated(function () {
+            Debugger::setOutputFormat('log');
+            Log::setConfig('array', ['engine' => 'Array']);
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $data = [
+                'level' => E_NOTICE,
+                'code' => E_NOTICE,
+                'file' => __FILE__,
+                'line' => __LINE__,
+                'description' => 'Error description',
+                'start' => 1,
+            ];
+            $debugger->outputError($data);
+            $output = ob_get_clean();
+            /** @var \Cake\Log\Engine\ArrayLog $logger */
+            $logger = Log::engine('array');
+            $logs = $logger->read();
+
+            $this->assertSame('', $output);
+            $this->assertCount(1, $logs);
+            // This is silly but that's how it works currently.
+            $this->assertStringContainsString("debug: \nCake\Error\Debugger::outputError()", $logs[0]);
+
+            $this->assertStringContainsString("'file' => '{$data['file']}'", $logs[0]);
+            $this->assertStringContainsString("'line' => (int) {$data['line']}", $logs[0]);
+            $this->assertStringContainsString("'trace' => ", $logs[0]);
+            $this->assertStringContainsString("'description' => 'Error description'", $logs[0]);
+            $this->assertStringContainsString('DebuggerTest::testOutputErrorLog()', $logs[0]);
+        });
     }
 
     /**
@@ -306,41 +325,43 @@ class DebuggerTest extends TestCase
      */
     public function testAddFormat(): void
     {
-        Debugger::addFormat('js', [
-            'traceLine' => '{:reference} - <a href="txmt://open?url=file://{:file}' .
-                '&line={:line}">{:path}</a>, line {:line}',
-        ]);
-        Debugger::setOutputFormat('js');
-
-        $result = Debugger::trace();
-        $this->assertMatchesRegularExpression('/' . preg_quote('txmt://open?url=file://', '/') . '(\/|[A-Z]:\\\\)' . '/', $result);
-
-        Debugger::addFormat('xml', [
-            'error' => '<error><code>{:code}</code><file>{:file}</file><line>{:line}</line>' .
-                '{:description}</error>',
-        ]);
-        Debugger::setOutputFormat('xml');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $debugger->outputError([
-            'level' => E_NOTICE,
-            'code' => E_NOTICE,
-            'file' => __FILE__,
-            'line' => __LINE__,
-            'description' => 'Undefined variable: foo',
-        ]);
-        $result = ob_get_clean();
-
-        $expected = [
-            '<error',
-            '<code', '8', '/code',
-            '<file', 'preg:/[^<]+/', '/file',
-            '<line', '' . ((int)__LINE__ - 9), '/line',
-            'preg:/Undefined variable:\s+foo/',
-            '/error',
-        ];
-        $this->assertHtml($expected, $result, true);
+        $this->deprecated(function () {
+            Debugger::addFormat('js', [
+                'traceLine' => '{:reference} - <a href="txmt://open?url=file://{:file}' .
+                    '&line={:line}">{:path}</a>, line {:line}',
+            ]);
+            Debugger::setOutputFormat('js');
+
+            $result = Debugger::trace();
+            $this->assertMatchesRegularExpression('/' . preg_quote('txmt://open?url=file://', '/') . '(\/|[A-Z]:\\\\)' . '/', $result);
+
+            Debugger::addFormat('xml', [
+                'error' => '<error><code>{:code}</code><file>{:file}</file><line>{:line}</line>' .
+                    '{:description}</error>',
+            ]);
+            Debugger::setOutputFormat('xml');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $debugger->outputError([
+                'level' => E_NOTICE,
+                'code' => E_NOTICE,
+                'file' => __FILE__,
+                'line' => __LINE__,
+                'description' => 'Undefined variable: foo',
+            ]);
+            $result = ob_get_clean();
+
+            $expected = [
+                '<error',
+                '<code', '8', '/code',
+                '<file', 'preg:/[^<]+/', '/file',
+                '<line', '' . ((int)__LINE__ - 9), '/line',
+                'preg:/Undefined variable:\s+foo/',
+                '/error',
+            ];
+            $this->assertHtml($expected, $result, true);
+        });
     }
 
     /**
@@ -348,24 +369,26 @@ class DebuggerTest extends TestCase
      */
     public function testAddFormatCallback(): void
     {
-        Debugger::addFormat('callback', ['callback' => [$this, 'customFormat']]);
-        Debugger::setOutputFormat('callback');
-
-        ob_start();
-        $debugger = Debugger::getInstance();
-        $debugger->outputError([
-            'error' => 'Notice',
-            'code' => E_NOTICE,
-            'level' => E_NOTICE,
-            'description' => 'Undefined variable $foo',
-            'file' => __FILE__,
-            'line' => __LINE__,
-        ]);
-        $result = ob_get_clean();
-        $this->assertStringContainsString('Notice: I eated an error', $result);
-        $this->assertStringContainsString('DebuggerTest.php', $result);
-
-        Debugger::setOutputFormat('js');
+        $this->deprecated(function () {
+            Debugger::addFormat('callback', ['callback' => [$this, 'customFormat']]);
+            Debugger::setOutputFormat('callback');
+
+            ob_start();
+            $debugger = Debugger::getInstance();
+            $debugger->outputError([
+                'error' => 'Notice',
+                'code' => E_NOTICE,
+                'level' => E_NOTICE,
+                'description' => 'Undefined variable $foo',
+                'file' => __FILE__,
+                'line' => __LINE__,
+            ]);
+            $result = ob_get_clean();
+            $this->assertStringContainsString('Notice: I eated an error', $result);
+            $this->assertStringContainsString('DebuggerTest.php', $result);
+
+            Debugger::setOutputFormat('js');
+        });
     }
 
     /**

tests/TestCase/Error/ErrorHandlerTest.php

@@ -111,16 +111,14 @@ class ErrorHandlerTest extends TestCase
     public function testHandleErrorDebugOn(): void
     {
         Configure::write('debug', true);
-        $errorHandler = new ErrorHandler();
-
-        $result = '';
-        $this->deprecated(function () use ($errorHandler, &$result) {
+        $this->deprecated(function () {
+            $errorHandler = new ErrorHandler();
             $errorHandler->register();
 
             ob_start();
             $wrong = $wrong + 1;
-            $result = ob_get_clean();
         });
+        $result = ob_get_clean();
 
         $this->assertMatchesRegularExpression('/<div class="cake-error">/', $result);
         if (version_compare(PHP_VERSION, '8.0.0-dev', '<')) {
@@ -184,8 +182,8 @@ class ErrorHandlerTest extends TestCase
      */
     public function testErrorMapping(int $error, string $expected): void
     {
-        $errorHandler = new ErrorHandler();
-        $this->deprecated(function () use ($errorHandler, $error, $expected) {
+        $this->deprecated(function () use ($error, $expected) {
+            $errorHandler = new ErrorHandler();
             $errorHandler->register();
 
             ob_start();