Skip to content

Commit e373350

Browse files
GromNaNGromNaN
authored
PHPORM-289 Support Laravel 12 (#3283)
1 parent 0a80c70 commit e373350

11 files changed

+142
-41
lines changed

‎.github/workflows/build-ci-atlas.yml

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ jobs:
2020
- "8.4"
2121
laravel:
2222
- "11.*"
23+
- "12.*"
2324

2425
steps:
2526
- uses: "actions/checkout@v4"

‎.github/workflows/build-ci.yml

+3-4
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,18 @@ jobs:
2828
laravel:
2929
- "10.*"
3030
- "11.*"
31+
- "12.*"
3132
include:
3233
- php: "8.1"
3334
laravel: "10.*"
3435
mongodb: "5.0"
3536
mode: "low-deps"
3637
os: "ubuntu-latest"
37-
- php: "8.4"
38-
laravel: "11.*"
39-
mongodb: "7.0"
40-
os: "ubuntu-latest"
4138
exclude:
4239
- php: "8.1"
4340
laravel: "11.*"
41+
- php: "8.1"
42+
laravel: "12.*"
4443

4544
steps:
4645
- uses: "actions/checkout@v4"

‎composer.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
"php": "^8.1",
2626
"ext-mongodb": "^1.15",
2727
"composer-runtime-api": "^2.0.0",
28-
"illuminate/cache": "^10.36|^11",
29-
"illuminate/container": "^10.0|^11",
30-
"illuminate/database": "^10.30|^11",
31-
"illuminate/events": "^10.0|^11",
32-
"illuminate/support": "^10.0|^11",
28+
"illuminate/cache": "^10.36|^11|^12",
29+
"illuminate/container": "^10.0|^11|^12",
30+
"illuminate/database": "^10.30|^11|^12",
31+
"illuminate/events": "^10.0|^11|^12",
32+
"illuminate/support": "^10.0|^11|^12",
3333
"mongodb/mongodb": "^1.21",
3434
"symfony/http-foundation": "^6.4|^7"
3535
},
@@ -38,8 +38,8 @@
3838
"league/flysystem-gridfs": "^3.28",
3939
"league/flysystem-read-only": "^3.0",
4040
"phpunit/phpunit": "^10.3|^11.5.3",
41-
"orchestra/testbench": "^8.0|^9.0",
42-
"mockery/mockery": "^1.4.4@stable",
41+
"orchestra/testbench": "^8.0|^9.0|^10.0",
42+
"mockery/mockery": "^1.4.4",
4343
"doctrine/coding-standard": "12.0.x-dev",
4444
"spatie/laravel-query-builder": "^5.6|^6",
4545
"phpstan/phpstan": "^1.10",

‎phpstan-baseline.neon

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
parameters:
22
ignoreErrors:
3+
-
4+
message: "#^Class MongoDB\\\\Laravel\\\\Query\\\\Grammar does not have a constructor and must be instantiated without any parameters\\.$#"
5+
count: 1
6+
path: src/Connection.php
7+
8+
-
9+
message: "#^Class MongoDB\\\\Laravel\\\\Schema\\\\Grammar does not have a constructor and must be instantiated without any parameters\\.$#"
10+
count: 1
11+
path: src/Connection.php
12+
313
-
414
message: "#^Access to an undefined property Illuminate\\\\Container\\\\Container\\:\\:\\$config\\.$#"
515
count: 3

‎src/Connection.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -355,13 +355,15 @@ protected function getDefaultPostProcessor()
355355
/** @inheritdoc */
356356
protected function getDefaultQueryGrammar()
357357
{
358-
return new Query\Grammar();
358+
// Argument added in Laravel 12
359+
return new Query\Grammar($this);
359360
}
360361

361362
/** @inheritdoc */
362363
protected function getDefaultSchemaGrammar()
363364
{
364-
return new Schema\Grammar();
365+
// Argument added in Laravel 12
366+
return new Schema\Grammar($this);
365367
}
366368

367369
/**

‎src/Schema/Blueprint.php

+7-22
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
namespace MongoDB\Laravel\Schema;
66

7-
use Illuminate\Database\Connection;
8-
use Illuminate\Database\Schema\Blueprint as SchemaBlueprint;
7+
use Illuminate\Database\Schema\Blueprint as BaseBlueprint;
98
use MongoDB\Collection;
9+
use MongoDB\Laravel\Connection;
1010

1111
use function array_flip;
1212
use function implode;
@@ -16,17 +16,14 @@
1616
use function is_string;
1717
use function key;
1818

19-
class Blueprint extends SchemaBlueprint
19+
/** @property Connection $connection */
20+
class Blueprint extends BaseBlueprint
2021
{
21-
/**
22-
* The MongoConnection object for this blueprint.
23-
*
24-
* @var Connection
25-
*/
26-
protected $connection;
22+
// Import $connection property and constructor for Laravel 12 compatibility
23+
use BlueprintLaravelCompatibility;
2724

2825
/**
29-
* The Collection object for this blueprint.
26+
* The MongoDB collection object for this blueprint.
3027
*
3128
* @var Collection
3229
*/
@@ -39,18 +36,6 @@ class Blueprint extends SchemaBlueprint
3936
*/
4037
protected $columns = [];
4138

42-
/**
43-
* Create a new schema blueprint.
44-
*/
45-
public function __construct(Connection $connection, string $collection)
46-
{
47-
parent::__construct($collection);
48-
49-
$this->connection = $connection;
50-
51-
$this->collection = $this->connection->getCollection($collection);
52-
}
53-
5439
/** @inheritdoc */
5540
public function index($columns = null, $name = null, $algorithm = null, $options = [])
5641
{

‎src/Schema/BlueprintLaravelCompatibility.php

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
namespace MongoDB\Laravel\Schema;
4+
5+
use Closure;
6+
use Illuminate\Database\Connection;
7+
use Illuminate\Database\Schema\Blueprint as BaseBlueprint;
8+
9+
use function property_exists;
10+
11+
/**
12+
* The $connection property and constructor param were added in Laravel 12
13+
* We keep the untyped $connection property for older version of Laravel to maintain compatibility
14+
* and not break projects that would extend the MongoDB Blueprint class.
15+
*
16+
* @see https://github.com/laravel/framework/commit/f29df4740d724f1c36385c9989569e3feb9422df#diff-68f714a9f1b751481b993414d3f1300ad55bcef12084ec0eb8f47f350033c24bR107
17+
*
18+
* phpcs:disable PSR1.Classes.ClassDeclaration.MultipleClasses
19+
*/
20+
if (! property_exists(BaseBlueprint::class, 'connection')) {
21+
/** @internal For compatibility with Laravel 10 and 11 */
22+
trait BlueprintLaravelCompatibility
23+
{
24+
/**
25+
* The MongoDB connection object for this blueprint.
26+
*
27+
* @var Connection
28+
*/
29+
protected $connection;
30+
31+
public function __construct(Connection $connection, string $collection, ?Closure $callback = null)
32+
{
33+
parent::__construct($collection, $callback);
34+
35+
$this->connection = $connection;
36+
$this->collection = $connection->getCollection($collection);
37+
}
38+
}
39+
} else {
40+
/** @internal For compatibility with Laravel 12+ */
41+
trait BlueprintLaravelCompatibility
42+
{
43+
public function __construct(Connection $connection, string $collection, ?Closure $callback = null)
44+
{
45+
parent::__construct($connection, $collection, $callback);
46+
47+
$this->collection = $connection->getCollection($collection);
48+
}
49+
}
50+
}

‎src/Schema/Builder.php

+32-5
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Closure;
88
use MongoDB\Collection;
99
use MongoDB\Driver\Exception\ServerException;
10+
use MongoDB\Laravel\Connection;
1011
use MongoDB\Model\CollectionInfo;
1112
use MongoDB\Model\IndexInfo;
1213

@@ -16,18 +17,22 @@
1617
use function array_keys;
1718
use function array_map;
1819
use function array_merge;
20+
use function array_values;
1921
use function assert;
2022
use function count;
2123
use function current;
2224
use function implode;
2325
use function in_array;
26+
use function is_array;
27+
use function is_string;
2428
use function iterator_to_array;
2529
use function sort;
2630
use function sprintf;
2731
use function str_ends_with;
2832
use function substr;
2933
use function usort;
3034

35+
/** @property Connection $connection */
3136
class Builder extends \Illuminate\Database\Schema\Builder
3237
{
3338
/**
@@ -137,9 +142,10 @@ public function dropAllTables()
137142
}
138143
}
139144

140-
public function getTables()
145+
/** @param string|null $schema Database name */
146+
public function getTables($schema = null)
141147
{
142-
$db = $this->connection->getDatabase();
148+
$db = $this->connection->getDatabase($schema);
143149
$collections = [];
144150

145151
foreach ($db->listCollectionNames() as $collectionName) {
@@ -150,7 +156,8 @@ public function getTables()
150156

151157
$collections[] = [
152158
'name' => $collectionName,
153-
'schema' => null,
159+
'schema' => $db->getDatabaseName(),
160+
'schema_qualified_name' => $db->getDatabaseName() . '.' . $collectionName,
154161
'size' => $stats[0]?->storageStats?->totalSize ?? null,
155162
'comment' => null,
156163
'collation' => null,
@@ -165,9 +172,29 @@ public function getTables()
165172
return $collections;
166173
}
167174

168-
public function getTableListing()
175+
/**
176+
* @param string|null $schema
177+
* @param bool $schemaQualified If a schema is provided, prefix the collection names with the schema name
178+
*
179+
* @return array
180+
*/
181+
public function getTableListing($schema = null, $schemaQualified = false)
169182
{
170-
$collections = iterator_to_array($this->connection->getDatabase()->listCollectionNames());
183+
$collections = [];
184+
185+
if ($schema === null || is_string($schema)) {
186+
$collections[$schema ?? 0] = iterator_to_array($this->connection->getDatabase($schema)->listCollectionNames());
187+
} elseif (is_array($schema)) {
188+
foreach ($schema as $db) {
189+
$collections[$db] = iterator_to_array($this->connection->getDatabase($db)->listCollectionNames());
190+
}
191+
}
192+
193+
if ($schema && $schemaQualified) {
194+
$collections = array_map(fn ($db, $collections) => array_map(static fn ($collection) => $db . '.' . $collection, $collections), array_keys($collections), $collections);
195+
}
196+
197+
$collections = array_merge(...array_values($collections));
171198

172199
sort($collections);
173200

‎tests/Query/BuilderTest.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1605,7 +1605,7 @@ private static function getBuilder(): Builder
16051605
$connection = m::mock(Connection::class);
16061606
$processor = m::mock(Processor::class);
16071607
$connection->shouldReceive('getSession')->andReturn(null);
1608-
$connection->shouldReceive('getQueryGrammar')->andReturn(new Grammar());
1608+
$connection->shouldReceive('getQueryGrammar')->andReturn(new Grammar($connection));
16091609

16101610
return new Builder($connection, null, $processor);
16111611
}

‎tests/RelationsTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ public function tearDown(): void
3535
Photo::truncate();
3636
Label::truncate();
3737
Skill::truncate();
38+
Soft::truncate();
3839

3940
parent::tearDown();
4041
}

‎tests/SchemaTest.php

+26
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,7 @@ public function testGetTables()
395395
{
396396
DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
397397
DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
398+
$dbName = DB::connection('mongodb')->getDatabaseName();
398399

399400
$tables = Schema::getTables();
400401
$this->assertIsArray($tables);
@@ -403,9 +404,13 @@ public function testGetTables()
403404
foreach ($tables as $table) {
404405
$this->assertArrayHasKey('name', $table);
405406
$this->assertArrayHasKey('size', $table);
407+
$this->assertArrayHasKey('schema', $table);
408+
$this->assertArrayHasKey('schema_qualified_name', $table);
406409

407410
if ($table['name'] === 'newcollection') {
408411
$this->assertEquals(8192, $table['size']);
412+
$this->assertEquals($dbName, $table['schema']);
413+
$this->assertEquals($dbName . '.newcollection', $table['schema_qualified_name']);
409414
$found = true;
410415
}
411416
}
@@ -428,6 +433,27 @@ public function testGetTableListing()
428433
$this->assertContains('newcollection_two', $tables);
429434
}
430435

436+
public function testGetTableListingBySchema()
437+
{
438+
DB::connection('mongodb')->table('newcollection')->insert(['test' => 'value']);
439+
DB::connection('mongodb')->table('newcollection_two')->insert(['test' => 'value']);
440+
$dbName = DB::connection('mongodb')->getDatabaseName();
441+
442+
$tables = Schema::getTableListing([$dbName, 'database__that_does_not_exists'], schemaQualified: true);
443+
444+
$this->assertIsArray($tables);
445+
$this->assertGreaterThanOrEqual(2, count($tables));
446+
$this->assertContains($dbName . '.newcollection', $tables);
447+
$this->assertContains($dbName . '.newcollection_two', $tables);
448+
449+
$tables = Schema::getTableListing([$dbName, 'database__that_does_not_exists'], schemaQualified: false);
450+
451+
$this->assertIsArray($tables);
452+
$this->assertGreaterThanOrEqual(2, count($tables));
453+
$this->assertContains('newcollection', $tables);
454+
$this->assertContains('newcollection_two', $tables);
455+
}
456+
431457
public function testGetColumns()
432458
{
433459
$collection = DB::connection('mongodb')->table('newcollection');

0 commit comments

Comments
 (0)