Remove deprecated lock-related methods (#6219)

|      Q       |   A
|------------- | -----------
| Type         | bug/feature/improvement
| Fixed issues | Follows #6191

#### Summary

This PR removed methods that have been deprecated in #6191.

Author: derrabus

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 4.0
 
+## BC BREAK: Removed lock-related `AbstractPlatform` methods
+
+The methods `AbstractPlatform::getReadLockSQL()`, `::getWriteLockSQL()` and `::getForUpdateSQL()` have been removed
+Use `QueryBuilder::forUpdate()` as a replacement for the latter.
+
 ## BC BREAK: BIGINT vales are cast to int if possible
 
 `BigIntType` casts values retrieved from the database to int if they're inside
@@ -215,9 +220,11 @@ The following classes have been converted to enums:
 1. `Doctrine\DBAL\ColumnCase`,
 2. `Doctrine\DBAL\LockMode`,
 3. `Doctrine\DBAL\ParameterType`,
-4. `Doctrine\DBAL\TransactionIsolationLevel`,
-5. `Doctrine\DBAL\Platforms\DateIntervalUnit`,
-6. `Doctrine\DBAL\Platforms\TrimMode`.
+4. `Doctrine\DBAL\ArrayParameterType`,
+5. `Doctrine\DBAL\TransactionIsolationLevel`,
+6. `Doctrine\DBAL\Platforms\DateIntervalUnit`,
+7. `Doctrine\DBAL\Platforms\TrimMode`.
+8. `Doctrine\DBAL\Query\ForUpdate\ConflictResolutionMode`
 
 The corresponding class constants are now instances of their enum type.
 

psalm.xml.dist

@@ -53,10 +53,6 @@
 
                 <!-- TODO for PHPUnit 11 -->
                 <referencedMethod name="PHPUnit\Framework\TestCase::iniSet"/>
-
-                <!-- TODO: remove in 4.0.0 -->
-                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::getForUpdateSQL"/>
-                <referencedMethod name="Doctrine\DBAL\Platforms\DB2Platform::getForUpdateSQL"/>
             </errorLevel>
         </DeprecatedMethod>
         <DocblockTypeContradiction>

src/Platforms/AbstractMySQLPlatform.php

@@ -739,11 +739,6 @@ public function getSetTransactionIsolationSQL(TransactionIsolationLevel $level):
         return 'SET SESSION TRANSACTION ISOLATION LEVEL ' . $this->_getTransactionIsolationLevelSQL($level);
     }
 
-    public function getReadLockSQL(): string
-    {
-        return 'LOCK IN SHARE MODE';
-    }
-
     protected function initializeDoctrineTypeMappings(): void
     {
         $this->doctrineTypeMapping = [

src/Platforms/AbstractPlatform.php

@@ -33,7 +33,6 @@
 use Doctrine\DBAL\Types;
 use Doctrine\DBAL\Types\Exception\TypeNotFound;
 use Doctrine\DBAL\Types\Type;
-use Doctrine\Deprecations\Deprecation;
 
 use function addcslashes;
 use function array_map;
@@ -701,23 +700,6 @@ public function getBitOrComparisonExpression(string $value1, string $value2): st
      */
     abstract public function getCurrentDatabaseExpression(): string;
 
-    /**
-     * Returns the FOR UPDATE expression.
-     *
-     * @deprecated This API is not portable. Use {@link QueryBuilder::forUpdate()}` instead.
-     */
-    public function getForUpdateSQL(): string
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6191',
-            '%s is deprecated as non-portable.',
-            __METHOD__,
-        );
-
-        return 'FOR UPDATE';
-    }
-
     /**
      * Honors that some SQL vendors such as MsSql use table hints for locking instead of the
      * ANSI SQL FOR UPDATE specification.
@@ -729,45 +711,6 @@ public function appendLockHint(string $fromClause, LockMode $lockMode): string
         return $fromClause;
     }
 
-    /**
-     * Returns the SQL snippet to append to any SELECT statement which locks rows in shared read lock.
-     *
-     * This defaults to the ANSI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database
-     * vendors allow to lighten this constraint up to be a real read lock.
-     *
-     * @deprecated This API is not portable.
-     */
-    public function getReadLockSQL(): string
-    {
-        Deprecation::trigger(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6191',
-            '%s is deprecated as non-portable.',
-            __METHOD__,
-        );
-
-        return $this->getForUpdateSQL();
-    }
-
-    /**
-     * Returns the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.
-     *
-     * The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ANSI SQL standard.
-     *
-     * @deprecated This API is not portable.
-     */
-    public function getWriteLockSQL(): string
-    {
-        Deprecation::trigger(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6191',
-            '%s is deprecated as non-portable.',
-            __METHOD__,
-        );
-
-        return $this->getForUpdateSQL();
-    }
-
     /**
      * Returns the SQL snippet to drop an existing table.
      */

src/Platforms/DB2Platform.php

@@ -564,12 +564,6 @@ public function createSelectSQLBuilder(): SelectSQLBuilder
         return new DefaultSelectSQLBuilder($this, 'WITH RR USE AND KEEP UPDATE LOCKS', null);
     }
 
-    /** @deprecated This API is not portable. */
-    public function getForUpdateSQL(): string
-    {
-        return ' WITH RR USE AND KEEP UPDATE LOCKS';
-    }
-
     public function getDummySelectSQL(string $expression = '1'): string
     {
         return sprintf('SELECT %s FROM sysibm.sysdummy1', $expression);

src/Platforms/PostgreSQLPlatform.php

@@ -685,11 +685,6 @@ public function getTruncateTableSQL(string $tableName, bool $cascade = false): s
         return $sql;
     }
 
-    public function getReadLockSQL(): string
-    {
-        return 'FOR SHARE';
-    }
-
     protected function initializeDoctrineTypeMappings(): void
     {
         $this->doctrineTypeMapping = [

src/Platforms/SQLServerPlatform.php

@@ -1096,12 +1096,6 @@ public function appendLockHint(string $fromClause, LockMode $lockMode): string
         };
     }
 
-    /** @deprecated This API is not portable. */
-    public function getForUpdateSQL(): string
-    {
-        return ' ';
-    }
-
     protected function createReservedKeywordsList(): KeywordList
     {
         return new SQLServerKeywords();

src/Platforms/SQLitePlatform.php

@@ -415,11 +415,6 @@ public function getTruncateTableSQL(string $tableName, bool $cascade = false): s
         return 'DELETE FROM ' . $tableIdentifier->getQuotedName($this);
     }
 
-    public function getForUpdateSQL(): string
-    {
-        return '';
-    }
-
     /** @internal The method should be only used from within the {@see AbstractPlatform} class hierarchy. */
     public function getInlineColumnCommentSQL(string $comment): string
     {

src/Query/ForUpdate.php

@@ -4,15 +4,17 @@
 
 namespace Doctrine\DBAL\Query;
 
+use Doctrine\DBAL\Query\ForUpdate\ConflictResolutionMode;
+
 /** @internal */
 final class ForUpdate
 {
     public function __construct(
-        private readonly int $conflictResolutionMode,
+        private readonly ConflictResolutionMode $conflictResolutionMode,
     ) {
     }
 
-    public function getConflictResolutionMode(): int
+    public function getConflictResolutionMode(): ConflictResolutionMode
     {
         return $this->conflictResolutionMode;
     }

src/Query/ForUpdate/ConflictResolutionMode.php

@@ -4,24 +4,15 @@
 
 namespace Doctrine\DBAL\Query\ForUpdate;
 
-final class ConflictResolutionMode
+enum ConflictResolutionMode
 {
     /**
      * Wait for the row to be unlocked
      */
-    public const ORDINARY = 0;
+    case ORDINARY;
 
     /**
      * Skip the row if it is locked
      */
-    public const SKIP_LOCKED = 1;
-
-    /**
-     * This class cannot be instantiated.
-     *
-     * @codeCoverageIgnore
-     */
-    private function __construct()
-    {
-    }
+    case SKIP_LOCKED;
 }

src/Query/QueryBuilder.php

@@ -492,7 +492,7 @@ public function getMaxResults(): ?int
      *
      * @return $this
      */
-    public function forUpdate(int $conflictResolutionMode = ConflictResolutionMode::ORDINARY): self
+    public function forUpdate(ConflictResolutionMode $conflictResolutionMode = ConflictResolutionMode::ORDINARY): self
     {
         $this->forUpdate = new ForUpdate($conflictResolutionMode);
 

tests/Platforms/DB2PlatformTest.php

@@ -321,7 +321,6 @@ public function testGeneratesSQLSnippets(): void
         );
 
         self::assertEquals("'1987/05/02' - 10 YEAR", $this->platform->getDateSubYearsExpression("'1987/05/02'", '10'));
-        self::assertEquals(' WITH RR USE AND KEEP UPDATE LOCKS', $this->platform->getForUpdateSQL());
 
         self::assertEquals(
             'LOCATE(substring_column, string_column)',