Adapt to Yii DB 2 (#88)

vjik · rustamwin · web-flow · commit 4619ec07d481 · 2025-12-11T09:29:42.000+03:00
Co-authored-by: Rustam Mamadaminov &lt;rmamdaminov@gmail.com&gt;
diff --git a/.github/workflows/mssql.yml b/.github/workflows/mssql.yml
@@ -94,7 +94,7 @@ jobs:
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Install db-mssql
-        run: composer require --dev "yiisoft/db-mssql:^1.1" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer require --dev "yiisoft/db-mssql:^2.0" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run tests with phpunit
         run: vendor/bin/phpunit --testsuite Mssql --coverage-clover=coverage.xml --colors=always
diff --git a/.github/workflows/mysql.yml b/.github/workflows/mysql.yml
@@ -85,7 +85,7 @@ jobs:
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Install db-mysql
-        run: composer require --dev "yiisoft/db-mysql:^1.1" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer require --dev "yiisoft/db-mysql:^2.0" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run tests with phpunit
         run: vendor/bin/phpunit --testsuite Mysql --coverage-clover=coverage.xml --colors=always
diff --git a/.github/workflows/oracle.yml b/.github/workflows/oracle.yml
@@ -91,7 +91,7 @@ jobs:
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Install db-oracle
-        run: composer require --dev "yiisoft/db-oracle:^1.2" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer require --dev "yiisoft/db-oracle:^2.0" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run tests with phpunit
         run: vendor/bin/phpunit --testsuite Oracle --coverage-clover=coverage.xml --colors=always
diff --git a/.github/workflows/pgsql.yml b/.github/workflows/pgsql.yml
@@ -90,7 +90,7 @@ jobs:
         run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Install db-pgsql
-        run: composer require --dev "yiisoft/db-pgsql:^1.2" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer require --dev "yiisoft/db-pgsql:^2.0" --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run tests with phpunit
         run: vendor/bin/phpunit --testsuite Pgsql --coverage-clover=coverage.xml --colors=always
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 2.0.1 under development
 
 - Enh #85: Refactor `AssignmentStorage::filterUserItemNames()` method (@vjik)
+- Chg #88: Adapt to Yii DB 2 (@vjik)
 - Enh #91: Bump `yiisoft/rbac` version to `^2.1` (@vjik)
 - Chg #92: Change PHP constraint in `composer.json` to `8.1 - 8.4` (@vjik)
 - Enh #92: Mark internal class `ItemTreeTraversalFactory` as final (@vjik)
diff --git a/composer.json b/composer.json
@@ -31,8 +31,8 @@
     "require": {
         "php": "8.1 - 8.4",
         "ext-pdo": "*",
-        "yiisoft/db": "^1.2",
-        "yiisoft/db-migration": "^1.1",
+        "yiisoft/db": "^2.0",
+        "yiisoft/db-migration": "^2.0",
         "yiisoft/friendly-exception": "^1.1",
         "yiisoft/rbac": "^2.1"
     },
@@ -46,15 +46,15 @@
         "spatie/phpunit-watcher": "^1.24",
         "vimeo/psalm": "^5.26.1 || ^6.10",
         "yiisoft/cache": "^3.0",
-        "yiisoft/db-sqlite": "^1.2"
+        "yiisoft/db-sqlite": "^2.0"
     },
     "suggest": {
         "yiisoft/db-sqlite": "For using with SQLite",
         "yiisoft/db-mysql": "For using with MySQL",
         "yiisoft/db-pgsql": "For using with PosgtgreSQL",
         "yiisoft/db-mssql": "For using with Microsoft SQL Server",
         "yiisoft/db-oracle": "For using with Oracle",
-        "yiisoft/yii-db-migration": "For automating schema migration"
+        "yiisoft/db-migration": "For automating schema migration"
     },
     "autoload": {
         "psr-4": {
diff --git a/src/AssignmentsStorage.php b/src/AssignmentsStorage.php
@@ -76,6 +76,7 @@ public function getByUserId(string $userId): array
     public function getByItemNames(array $itemNames): array
     {
         if (empty($itemNames)) {
+            /** @infection-ignore-all  */
             return [];
         }
 
@@ -123,6 +124,7 @@ public function exists(string $itemName, string $userId): bool
     public function userHasItem(string $userId, array $itemNames): bool
     {
         if (empty($itemNames)) {
+            /** @infection-ignore-all  */
             return false;
         }
 
diff --git a/src/ItemsStorage.php b/src/ItemsStorage.php
@@ -110,6 +110,7 @@ public function getAll(): array
     public function getByNames(array $names): array
     {
         if (empty($names)) {
+            /** @infection-ignore-all  */
             return [];
         }
 
@@ -167,6 +168,9 @@ public function update(string $name, Item $item): void
         $this
             ->database
             ->transaction(static function (ConnectionInterface $database) use ($itemsStorage, $name, $item): void {
+                /**
+                 * @var array[] $itemsChildren We assume that arrays are returned here, not objects.
+                 */
                 $itemsChildren = (new Query($database))
                     ->from($itemsStorage->childrenTableName)
                     ->where(['parent' => $name])
@@ -198,7 +202,7 @@ static function (array $itemChild) use ($name, $item): array {
                     );
                     $database
                         ->createCommand()
-                        ->batchInsert($itemsStorage->childrenTableName, ['parent', 'child'], $itemsChildren)
+                        ->insertBatch($itemsStorage->childrenTableName, $itemsChildren, ['parent', 'child'])
                         ->execute();
                 }
             });
@@ -224,6 +228,7 @@ public function getRoles(): array
     public function getRolesByNames(array $names): array
     {
         if (empty($names)) {
+            /** @infection-ignore-all  */
             return [];
         }
 
@@ -255,6 +260,7 @@ public function getPermissions(): array
     public function getPermissionsByNames(array $names): array
     {
         if (empty($names)) {
+            /** @infection-ignore-all  */
             return [];
         }
 
diff --git a/tests/Base/AssignmentsStorageTest.php b/tests/Base/AssignmentsStorageTest.php
@@ -33,10 +33,10 @@ protected function populateItemsStorage(): void
     {
         $this->getDatabase()
             ->createCommand()
-            ->batchInsert(
+            ->insertBatch(
                 self::$itemsTable,
-                ['name', 'type', 'created_at', 'updated_at'],
                 $this->getFixtures()['items'],
+                ['name', 'type', 'created_at', 'updated_at'],
             )
             ->execute();
     }
@@ -45,10 +45,10 @@ protected function populateAssignmentsStorage(): void
     {
         $this->getDatabase()
             ->createCommand()
-            ->batchInsert(
+            ->insertBatch(
                 self::$assignmentsTable,
-                ['item_name', 'user_id', 'created_at'],
                 $this->getFixtures()['assignments'],
+                ['item_name', 'user_id', 'created_at'],
             )
             ->execute();
     }
diff --git a/tests/Base/ItemsStorageTest.php b/tests/Base/ItemsStorageTest.php
@@ -154,12 +154,12 @@ protected function populateItemsStorage(): void
         $this
             ->getDatabase()
             ->createCommand()
-            ->batchInsert(self::$itemsTable, ['name', 'type', 'created_at', 'updated_at'], $fixtures['items'])
+            ->insertBatch(self::$itemsTable, $fixtures['items'], ['name', 'type', 'created_at', 'updated_at'])
             ->execute();
         $this
             ->getDatabase()
             ->createCommand()
-            ->batchInsert(self::$itemsChildrenTable, ['parent', 'child'], $fixtures['itemsChildren'])
+            ->insertBatch(self::$itemsChildrenTable, $fixtures['itemsChildren'], ['parent', 'child'])
             ->execute();
     }
 
diff --git a/tests/Base/SchemaTrait.php b/tests/Base/SchemaTrait.php
@@ -5,9 +5,10 @@
 namespace Yiisoft\Rbac\Db\Tests\Base;
 
 use PHPUnit\Framework\ExpectationFailedException;
-use Yiisoft\Db\Constraint\Constraint;
-use Yiisoft\Db\Constraint\ForeignKeyConstraint;
-use Yiisoft\Db\Constraint\IndexConstraint;
+use Yiisoft\Db\Constraint\ForeignKey;
+use Yiisoft\Db\Constraint\Index;
+
+use function is_array;
 
 trait SchemaTrait
 {
@@ -55,17 +56,18 @@ protected function checkItemsChildrenTable(): void
         $parent = $columns['parent'];
         $this->assertSame('string', $parent->getType());
         $this->assertSame(126, $parent->getSize());
-        $this->assertFalse($parent->isAllowNull());
+        $this->assertTrue($parent->isNotNull());
 
         $this->assertArrayHasKey('child', $columns);
         $child = $columns['child'];
         $this->assertSame('string', $child->getType());
         $this->assertSame(126, $child->getSize());
-        $this->assertFalse($child->isAllowNull());
+        $this->assertTrue($child->isNotNull());
 
         $primaryKey = $databaseSchema->getTablePrimaryKey(self::$itemsChildrenTable);
-        $this->assertInstanceOf(Constraint::class, $primaryKey);
-        $this->assertEqualsCanonicalizing(['parent', 'child'], $primaryKey->getColumnNames());
+        $this->assertInstanceOf(Index::class, $primaryKey);
+        $this->assertTrue($primaryKey->isPrimaryKey);
+        $this->assertEqualsCanonicalizing(['parent', 'child'], $primaryKey->columnNames);
     }
 
     protected function assertForeignKey(
@@ -77,34 +79,34 @@ protected function assertForeignKey(
         null|string|array $expectedOnUpdate = 'NO ACTION',
         null|string|array $expectedOnDelete = 'NO ACTION',
     ): void {
-        /** @var ForeignKeyConstraint[] $foreignKeys */
+        /** @var ForeignKey[] $foreignKeys */
         $foreignKeys = $this->getDatabase()->getSchema()->getTableForeignKeys($table);
         $found = false;
         foreach ($foreignKeys as $foreignKey) {
             try {
-                $this->assertEqualsCanonicalizing($expectedColumnNames, $foreignKey->getColumnNames());
-                $this->assertSame($expectedForeignTableName, $foreignKey->getForeignTableName());
-                $this->assertEqualsCanonicalizing($expectedForeignColumnNames, $foreignKey->getForeignColumnNames());
+                $this->assertEqualsCanonicalizing($expectedColumnNames, $foreignKey->columnNames);
+                $this->assertSame($expectedForeignTableName, $foreignKey->foreignTableName);
+                $this->assertEqualsCanonicalizing($expectedForeignColumnNames, $foreignKey->foreignColumnNames);
             } catch (ExpectationFailedException) {
                 continue;
             }
 
             $found = true;
 
             if (is_array($expectedOnUpdate)) {
-                $this->assertContains($foreignKey->getOnUpdate(), $expectedOnUpdate);
+                $this->assertContains($foreignKey->onUpdate, $expectedOnUpdate);
             } else {
-                $this->assertSame($expectedOnUpdate, $foreignKey->getOnUpdate());
+                $this->assertSame($expectedOnUpdate, $foreignKey->onUpdate);
             }
 
             if (is_array($expectedOnDelete)) {
-                $this->assertContains($foreignKey->getOnDelete(), $expectedOnDelete);
+                $this->assertContains($foreignKey->onDelete, $expectedOnDelete);
             } else {
-                $this->assertSame($expectedOnDelete, $foreignKey->getOnDelete());
+                $this->assertSame($expectedOnDelete, $foreignKey->onDelete);
             }
 
             if ($expectedName !== null) {
-                $this->assertSame($expectedName, $foreignKey->getName());
+                $this->assertSame($expectedName, $foreignKey->name);
             }
         }
 
@@ -120,23 +122,23 @@ protected function assertIndex(
         bool $expectedIsUnique = false,
         bool $expectedIsPrimary = false,
     ): void {
-        /** @var IndexConstraint[] $indexes */
+        /** @var Index[] $indexes */
         $indexes = $this->getDatabase()->getSchema()->getTableIndexes($table);
         $found = false;
         foreach ($indexes as $index) {
             try {
-                $this->assertEqualsCanonicalizing($expectedColumnNames, $index->getColumnNames());
+                $this->assertEqualsCanonicalizing($expectedColumnNames, $index->columnNames);
             } catch (ExpectationFailedException) {
                 continue;
             }
 
             $found = true;
 
-            $this->assertSame($expectedIsUnique, $index->isUnique());
-            $this->assertSame($expectedIsPrimary, $index->isPrimary());
+            $this->assertSame($expectedIsUnique, $index->isUnique);
+            $this->assertSame($expectedIsPrimary, $index->isPrimaryKey);
 
             if ($expectedName !== null) {
-                $this->assertSame($expectedName, $index->getName());
+                $this->assertSame($expectedName, $index->name);
             }
         }
 
@@ -166,39 +168,40 @@ private function checkItemsTable(): void
         $name = $columns['name'];
         $this->assertSame('string', $name->getType());
         $this->assertSame(126, $name->getSize());
-        $this->assertFalse($name->isAllowNull());
+        $this->assertTrue($name->isNotNull());
 
         $this->assertArrayHasKey('type', $columns);
         $type = $columns['type'];
         $this->assertSame('string', $type->getType());
         $this->assertSame(10, $type->getSize());
-        $this->assertFalse($type->isAllowNull());
+        $this->assertTrue($type->isNotNull());
 
         $this->assertArrayHasKey('description', $columns);
         $description = $columns['description'];
         $this->assertSame('string', $description->getType());
         $this->assertSame(191, $description->getSize());
-        $this->assertTrue($description->isAllowNull());
+        $this->assertFalse($description->isNotNull());
 
         $this->assertArrayHasKey('rule_name', $columns);
         $ruleName = $columns['rule_name'];
         $this->assertSame('string', $ruleName->getType());
         $this->assertSame(64, $ruleName->getSize());
-        $this->assertTrue($ruleName->isAllowNull());
+        $this->assertFalse($ruleName->isNotNull());
 
         $this->assertArrayHasKey('created_at', $columns);
         $createdAt = $columns['created_at'];
         $this->assertSame('integer', $createdAt->getType());
-        $this->assertFalse($createdAt->isAllowNull());
+        $this->assertTrue($createdAt->isNotNull());
 
         $this->assertArrayHasKey('updated_at', $columns);
         $updatedAt = $columns['updated_at'];
         $this->assertSame('integer', $updatedAt->getType());
-        $this->assertFalse($updatedAt->isAllowNull());
+        $this->assertTrue($updatedAt->isNotNull());
 
         $primaryKey = $databaseSchema->getTablePrimaryKey(self::$itemsTable);
-        $this->assertInstanceOf(Constraint::class, $primaryKey);
-        $this->assertSame(['name'], $primaryKey->getColumnNames());
+        $this->assertInstanceOf(Index::class, $primaryKey);
+        $this->assertTrue($primaryKey->isPrimaryKey);
+        $this->assertSame(['name'], $primaryKey->columnNames);
 
         $this->assertCount(0, $databaseSchema->getTableForeignKeys(self::$itemsTable));
 
@@ -230,22 +233,23 @@ private function checkAssignmentsTable(): void
         $itemName = $columns['item_name'];
         $this->assertSame('string', $itemName->getType());
         $this->assertSame(126, $itemName->getSize());
-        $this->assertFalse($itemName->isAllowNull());
+        $this->assertTrue($itemName->isNotNull());
 
         $this->assertArrayHasKey('user_id', $columns);
         $userId = $columns['user_id'];
         $this->assertSame('string', $userId->getType());
         $this->assertSame(126, $userId->getSize());
-        $this->assertFalse($userId->isAllowNull());
+        $this->assertTrue($userId->isNotNull());
 
         $this->assertArrayHasKey('created_at', $columns);
         $createdAt = $columns['created_at'];
         $this->assertSame('integer', $createdAt->getType());
-        $this->assertFalse($createdAt->isAllowNull());
+        $this->assertTrue($createdAt->isNotNull());
 
         $primaryKey = $databaseSchema->getTablePrimaryKey(self::$assignmentsTable);
-        $this->assertInstanceOf(Constraint::class, $primaryKey);
-        $this->assertEqualsCanonicalizing(['item_name', 'user_id'], $primaryKey->getColumnNames());
+        $this->assertInstanceOf(Index::class, $primaryKey);
+        $this->assertTrue($primaryKey->isPrimaryKey);
+        $this->assertEqualsCanonicalizing(['item_name', 'user_id'], $primaryKey->columnNames);
 
         $this->assertCount(0, $databaseSchema->getTableForeignKeys(self::$assignmentsTable));
 
diff --git a/tests/Mssql/SchemaTrait.php b/tests/Mssql/SchemaTrait.php
@@ -19,16 +19,16 @@ protected function checkItemsChildrenTable(): void
             expectedColumnNames: ['parent'],
             expectedForeignTableName: self::$itemsTable,
             expectedForeignColumnNames: ['name'],
-            expectedOnUpdate: 'NOACTION',
-            expectedOnDelete: 'NOACTION',
+            expectedOnUpdate: 'NO ACTION',
+            expectedOnDelete: 'NO ACTION',
         );
         $this->assertForeignKey(
             table: self::$itemsChildrenTable,
             expectedColumnNames: ['child'],
             expectedForeignTableName: self::$itemsTable,
             expectedForeignColumnNames: ['name'],
-            expectedOnUpdate: 'NOACTION',
-            expectedOnDelete: 'NOACTION',
+            expectedOnUpdate: 'NO ACTION',
+            expectedOnDelete: 'NO ACTION',
         );
 
         $this->assertCount(

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ public function getByUserId(string $userId): array`
`76`	`76`	`public function getByItemNames(array $itemNames): array`
`77`	`77`	`{`
`78`	`78`	`if (empty($itemNames)) {`
	`79`	`+ /** @infection-ignore-all */`
`79`	`80`	`return [];`
`80`	`81`	`}`
`81`	`82`
`@@ -123,6 +124,7 @@ public function exists(string $itemName, string $userId): bool`
`123`	`124`	`public function userHasItem(string $userId, array $itemNames): bool`
`124`	`125`	`{`
`125`	`126`	`if (empty($itemNames)) {`
	`127`	`+ /** @infection-ignore-all */`
`126`	`128`	`return false;`
`127`	`129`	`}`
`128`	`130`
Original file line number	Diff line number	Diff line change
`@@ -110,6 +110,7 @@ public function getAll(): array`
`110`	`110`	`public function getByNames(array $names): array`
`111`	`111`	`{`
`112`	`112`	`if (empty($names)) {`
	`113`	`+ /** @infection-ignore-all */`
`113`	`114`	`return [];`
`114`	`115`	`}`
`115`	`116`
`@@ -167,6 +168,9 @@ public function update(string $name, Item $item): void`
`167`	`168`	`$this`
`168`	`169`	`->database`
`169`	`170`	`->transaction(static function (ConnectionInterface $database) use ($itemsStorage, $name, $item): void {`
	`171`	`+ /**`
	`172`	`+ * @var array[] $itemsChildren We assume that arrays are returned here, not objects.`
	`173`	`+ */`
`170`	`174`	`$itemsChildren = (new Query($database))`
`171`	`175`	`->from($itemsStorage->childrenTableName)`
`172`	`176`	`->where(['parent' => $name])`
`@@ -198,7 +202,7 @@ static function (array $itemChild) use ($name, $item): array {`
`198`	`202`	`);`
`199`	`203`	`$database`
`200`	`204`	`->createCommand()`
`201`		`- ->batchInsert($itemsStorage->childrenTableName, ['parent', 'child'], $itemsChildren)`
	`205`	`+ ->insertBatch($itemsStorage->childrenTableName, $itemsChildren, ['parent', 'child'])`
`202`	`206`	`->execute();`
`203`	`207`	`}`
`204`	`208`	`});`
`@@ -224,6 +228,7 @@ public function getRoles(): array`
`224`	`228`	`public function getRolesByNames(array $names): array`
`225`	`229`	`{`
`226`	`230`	`if (empty($names)) {`
	`231`	`+ /** @infection-ignore-all */`
`227`	`232`	`return [];`
`228`	`233`	`}`
`229`	`234`
`@@ -255,6 +260,7 @@ public function getPermissions(): array`
`255`	`260`	`public function getPermissionsByNames(array $names): array`
`256`	`261`	`{`
`257`	`262`	`if (empty($names)) {`
	`263`	`+ /** @infection-ignore-all */`
`258`	`264`	`return [];`
`259`	`265`	`}`
`260`	`266`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,10 @@ protected function populateItemsStorage(): void`
`33`	`33`	`{`
`34`	`34`	`$this->getDatabase()`
`35`	`35`	`->createCommand()`
`36`		`- ->batchInsert(`
	`36`	`+ ->insertBatch(`
`37`	`37`	`self::$itemsTable,`
`38`		`- ['name', 'type', 'created_at', 'updated_at'],`
`39`	`38`	`$this->getFixtures()['items'],`
	`39`	`+ ['name', 'type', 'created_at', 'updated_at'],`
`40`	`40`	`)`
`41`	`41`	`->execute();`
`42`	`42`	`}`
`@@ -45,10 +45,10 @@ protected function populateAssignmentsStorage(): void`
`45`	`45`	`{`
`46`	`46`	`$this->getDatabase()`
`47`	`47`	`->createCommand()`
`48`		`- ->batchInsert(`
	`48`	`+ ->insertBatch(`
`49`	`49`	`self::$assignmentsTable,`
`50`		`- ['item_name', 'user_id', 'created_at'],`
`51`	`50`	`$this->getFixtures()['assignments'],`
	`51`	`+ ['item_name', 'user_id', 'created_at'],`
`52`	`52`	`)`
`53`	`53`	`->execute();`
`54`	`54`	`}`