mirror of
https://github.com/doctrine/orm.git
synced 2026-04-23 22:48:08 +02:00
Compare commits
195 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8ceb0b0d04 | |||
| e88cd591f0 | |||
| 88a8f75f62 | |||
| 9fe8ce4bf7 | |||
| a46ff16339 | |||
| 94e60e4318 | |||
| f59cd4019a | |||
| 81558a8b2a | |||
| e431ee113d | |||
| de4ec208fd | |||
| df014a74c9 | |||
| 2f46d95028 | |||
| 3fda5629f6 | |||
| 6b273234d6 | |||
| 580a95ce3f | |||
| 8b91e248eb | |||
| d2266c7d0c | |||
| eb0485869a | |||
| 8372d600c6 | |||
| dde1d71b34 | |||
| 0d03255061 | |||
| 75a18090d9 | |||
| 77ffd2ab68 | |||
| 401cc06d71 | |||
| 5029b193ee | |||
| b87781f65e | |||
| c0ff86ef69 | |||
| 77b579287c | |||
| 27c33cf88d | |||
| 6068b61a0d | |||
| 00024f7d88 | |||
| 255612a1ff | |||
| 331f8b52cb | |||
| b2faba62b7 | |||
| da426a0036 | |||
| 1891a76f13 | |||
| 14bb034fe4 | |||
| afc0aab61a | |||
| e1d7a13a5e | |||
| 4262eb495b | |||
| fe6e5a67f8 | |||
| b20a66dcdd | |||
| dc46af27ed | |||
| 05ab22710b | |||
| d3b47d2cbb | |||
| 026f5bfe1b | |||
| 6af7de38e1 | |||
| 0b0f2f4d86 | |||
| 63d9a898ec | |||
| 0bd839a720 | |||
| b65004fc26 | |||
| d2418ab074 | |||
| 39a05e31c9 | |||
| ab156a551c | |||
| 0fc9208d71 | |||
| fd9e572424 | |||
| 76490f2c99 | |||
| 2148940290 | |||
| d3538095fd | |||
| 0c1bf14729 | |||
| 3b8c23c51d | |||
| 60d4ea694a | |||
| e923bbc932 | |||
| 8cbd34c666 | |||
| f8bbdc40b0 | |||
| 8bdefef6d1 | |||
| 0f8730a6e5 | |||
| 62477b5d42 | |||
| 12116aa3c2 | |||
| 0aeddd0592 | |||
| 2491c4b20d | |||
| 08d6167243 | |||
| d4e9276e79 | |||
| cee74faa97 | |||
| 9ae2181185 | |||
| 3e25efd72b | |||
| 47496ed882 | |||
| 492745d710 | |||
| 67419cf951 | |||
| 1237f5c909 | |||
| 609e616f2d | |||
| 4016d6ba4b | |||
| dcdd46251e | |||
| 3d98b43561 | |||
| 9f3f70944a | |||
| 05e07c0ae0 | |||
| fea42ab984 | |||
| 7c347b85c1 | |||
| 458b040d93 | |||
| 396636a2c2 | |||
| 78dd074266 | |||
| ff22a00fcf | |||
| 02e8ff9663 | |||
| 01fd55e9ea | |||
| 2e75a7f1c1 | |||
| 152b0e3d65 | |||
| 9d11fdd3da | |||
| 87f1ba74e0 | |||
| f357a33d23 | |||
| ee70178314 | |||
| ab148d3d9d | |||
| 3924c38fab | |||
| 9814078a2c | |||
| 6de5684fd9 | |||
| c142503a52 | |||
| 01c178b297 | |||
| ffa50a777f | |||
| 649048f745 | |||
| 15537bc218 | |||
| bc95c7c08d | |||
| 6982c8ab9d | |||
| 3df11d518c | |||
| c1becd54e6 | |||
| e4d7df29c2 | |||
| 608705427e | |||
| f0562f4120 | |||
| 9f19310f27 | |||
| e38278bfca | |||
| 62f2cff218 | |||
| cdd774906b | |||
| 96776e091d | |||
| f7470d8a3f | |||
| 2c41cc7f1c | |||
| f18de9d569 | |||
| 37f76a8381 | |||
| a6c1e63a60 | |||
| b62292256a | |||
| b138395194 | |||
| 6881cdff4c | |||
| dede2d775a | |||
| c502190712 | |||
| 5bff0919a7 | |||
| 9ef0f5301b | |||
| 4989ca6f15 | |||
| 32d1e97ce7 | |||
| ca8147b148 | |||
| c8ebea77f0 | |||
| 23f22860f1 | |||
| b24586b1b5 | |||
| 9e5442a892 | |||
| 7d8e51c934 | |||
| 2f8f1cfcb8 | |||
| fe5ee705db | |||
| 01774c035c | |||
| 0511a9f790 | |||
| 0e3d5e8c82 | |||
| 72ffb3bfbf | |||
| 2e9a1adc23 | |||
| 6f83166266 | |||
| ffd3f50ad7 | |||
| 483b45d449 | |||
| dd4e8fe78f | |||
| 7cc210424c | |||
| 4fd9e94819 | |||
| 587caf88a7 | |||
| 1e33b775d3 | |||
| 28d9472a38 | |||
| c6955ec056 | |||
| 6863272943 | |||
| c472a1535d | |||
| f1a8ee175c | |||
| 28dd32790f | |||
| ac19b21a71 | |||
| cb8a76ba3a | |||
| a7a14cffaf | |||
| ceb04bf3f6 | |||
| ed9ba16ff4 | |||
| fc1bf3b815 | |||
| b6b342cada | |||
| bea4814d55 | |||
| 238c15952c | |||
| fdc88ba236 | |||
| c49bf58682 | |||
| ce844d94a0 | |||
| c1f7a60c5b | |||
| d1d13d5956 | |||
| 4f8dde2d1e | |||
| e3c320c705 | |||
| 831232e05e | |||
| a774cedb24 | |||
| 6b8207bb11 | |||
| 3d3b5b51cd | |||
| 760616291b | |||
| 8584da8fdc | |||
| 07bb0def60 | |||
| 8cf161d8bc | |||
| a2990e1a0a | |||
| d355c4a990 | |||
| 88c395c488 | |||
| 256d6cb0d7 | |||
| a1fdc6eb6e | |||
| d583460d63 | |||
| 79d4cfdce8 | |||
| 5301b99533 | |||
| 00c7b70211 |
+6
-51
@@ -12,42 +12,17 @@
|
||||
"upcoming": true
|
||||
},
|
||||
{
|
||||
"name": "3.6",
|
||||
"branchName": "3.6.x",
|
||||
"slug": "3.6",
|
||||
"name": "3.7",
|
||||
"branchName": "3.7.x",
|
||||
"slug": "3.7",
|
||||
"upcoming": true
|
||||
},
|
||||
{
|
||||
"name": "3.5",
|
||||
"branchName": "3.5.x",
|
||||
"slug": "3.5",
|
||||
"name": "3.6",
|
||||
"branchName": "3.6.x",
|
||||
"slug": "3.6",
|
||||
"current": true
|
||||
},
|
||||
{
|
||||
"name": "3.4",
|
||||
"slug": "3.4",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "3.3",
|
||||
"slug": "3.3",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "3.2",
|
||||
"slug": "3.2",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "3.1",
|
||||
"slug": "3.1",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "3.0",
|
||||
"slug": "3.0",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "2.21",
|
||||
"branchName": "2.21.x",
|
||||
@@ -89,26 +64,6 @@
|
||||
"name": "2.14",
|
||||
"slug": "2.14",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "2.13",
|
||||
"slug": "2.13",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "2.12",
|
||||
"slug": "2.12",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "2.11",
|
||||
"slug": "2.11",
|
||||
"maintained": false
|
||||
},
|
||||
{
|
||||
"name": "2.10",
|
||||
"slug": "2.10",
|
||||
"maintained": false
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
+1
-1
@@ -15,6 +15,6 @@ phpcs.xml.dist export-ignore
|
||||
phpbench.json export-ignore
|
||||
phpstan.neon export-ignore
|
||||
phpstan-baseline.neon export-ignore
|
||||
phpstan-dbal2.neon export-ignore
|
||||
phpstan-dbal3.neon export-ignore
|
||||
phpstan-params.neon export-ignore
|
||||
phpstan-persistence2.neon export-ignore
|
||||
|
||||
@@ -7,3 +7,7 @@ updates:
|
||||
labels:
|
||||
- "CI"
|
||||
target-branch: "2.20.x"
|
||||
groups:
|
||||
doctrine:
|
||||
patterns:
|
||||
- "doctrine/*"
|
||||
|
||||
@@ -24,4 +24,4 @@ on:
|
||||
|
||||
jobs:
|
||||
coding-standards:
|
||||
uses: "doctrine/.github/.github/workflows/coding-standards.yml@12.1.0"
|
||||
uses: "doctrine/.github/.github/workflows/coding-standards.yml@14.0.0"
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
name: "Composer Lint"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- "*.x"
|
||||
paths:
|
||||
- ".github/workflows/composer-lint.yml"
|
||||
- "composer.json"
|
||||
push:
|
||||
branches:
|
||||
- "*.x"
|
||||
paths:
|
||||
- ".github/workflows/composer-lint.yml"
|
||||
- "composer.json"
|
||||
|
||||
jobs:
|
||||
composer-lint:
|
||||
name: "Composer Lint"
|
||||
uses: "doctrine/.github/.github/workflows/composer-lint.yml@14.0.0"
|
||||
@@ -1,4 +1,4 @@
|
||||
name: "CI"
|
||||
name: "CI: PHPUnit"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
@@ -25,7 +25,14 @@ env:
|
||||
|
||||
jobs:
|
||||
phpunit-smoke-check:
|
||||
name: "PHPUnit with SQLite"
|
||||
name: >
|
||||
SQLite -
|
||||
${{ format('PHP {0} - DBAL {1} - ext. {2} - proxy {3}',
|
||||
matrix.php-version || 'Ø',
|
||||
matrix.dbal-version || 'Ø',
|
||||
matrix.extension || 'Ø',
|
||||
matrix.proxy || 'Ø'
|
||||
) }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
|
||||
strategy:
|
||||
@@ -44,31 +51,43 @@ jobs:
|
||||
- "pdo_sqlite"
|
||||
deps:
|
||||
- "highest"
|
||||
stability:
|
||||
- "stable"
|
||||
native_lazy:
|
||||
- "0"
|
||||
include:
|
||||
- php-version: "8.2"
|
||||
dbal-version: "4@dev"
|
||||
extension: "pdo_sqlite"
|
||||
stability: "stable"
|
||||
native_lazy: "0"
|
||||
- php-version: "8.2"
|
||||
dbal-version: "4@dev"
|
||||
extension: "sqlite3"
|
||||
stability: "stable"
|
||||
native_lazy: "0"
|
||||
- php-version: "8.1"
|
||||
dbal-version: "default"
|
||||
deps: "lowest"
|
||||
extension: "pdo_sqlite"
|
||||
stability: "stable"
|
||||
native_lazy: "0"
|
||||
- php-version: "8.4"
|
||||
dbal-version: "default"
|
||||
deps: "highest"
|
||||
extension: "pdo_sqlite"
|
||||
stability: "stable"
|
||||
native_lazy: "1"
|
||||
- php-version: "8.4"
|
||||
dbal-version: "default"
|
||||
deps: "highest"
|
||||
extension: "sqlite3"
|
||||
stability: "dev"
|
||||
native_lazy: "1"
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
@@ -80,12 +99,24 @@ jobs:
|
||||
coverage: "pcov"
|
||||
ini-values: "zend.assertions=1, apc.enable_cli=1"
|
||||
|
||||
- name: "Allow dev dependencies"
|
||||
run: |
|
||||
composer config minimum-stability dev
|
||||
composer remove --no-update --dev phpbench/phpbench phpdocumentor/guides-cli
|
||||
composer require --no-update symfony/console:^8 symfony/var-exporter:^8 doctrine/dbal:^4.4
|
||||
composer require --dev --no-update symfony/cache:^8
|
||||
if: "${{ matrix.stability == 'dev' }}"
|
||||
|
||||
- name: "Require specific DBAL version"
|
||||
run: "composer require doctrine/dbal ^${{ matrix.dbal-version }} --no-update"
|
||||
if: "${{ matrix.dbal-version != 'default' }}"
|
||||
|
||||
- name: "Downgrade VarExporter"
|
||||
run: 'composer require --no-update "symfony/var-exporter:^6.4 || ^7.4"'
|
||||
if: "${{ matrix.native_lazy == '0' }}"
|
||||
|
||||
- name: "Install dependencies with Composer"
|
||||
uses: "ramsey/composer-install@v3"
|
||||
uses: "ramsey/composer-install@v4"
|
||||
with:
|
||||
composer-options: "--ignore-platform-req=php+"
|
||||
dependency-versions: "${{ matrix.deps }}"
|
||||
@@ -119,9 +150,9 @@ jobs:
|
||||
ENABLE_NATIVE_LAZY_OBJECTS: ${{ matrix.native_lazy }}
|
||||
|
||||
- name: "Upload coverage file"
|
||||
uses: "actions/upload-artifact@v5"
|
||||
uses: "actions/upload-artifact@v7"
|
||||
with:
|
||||
name: "phpunit-${{ matrix.extension }}-${{ matrix.php-version }}-${{ matrix.dbal-version }}-${{ matrix.deps }}-${{ matrix.native_lazy }}-coverage"
|
||||
name: "phpunit-${{ matrix.extension }}-${{ matrix.php-version }}-${{ matrix.dbal-version }}-${{ matrix.deps }}-${{ matrix.stability }}-${{ matrix.native_lazy }}-coverage"
|
||||
path: "coverage*.xml"
|
||||
|
||||
|
||||
@@ -160,7 +191,13 @@ jobs:
|
||||
|
||||
|
||||
phpunit-postgres:
|
||||
name: "PHPUnit with PostgreSQL"
|
||||
name: >
|
||||
${{ format('PostgreSQL {0} - PHP {1} - DBAL {2} - ext. {3}',
|
||||
matrix.postgres-version || 'Ø',
|
||||
matrix.php-version || 'Ø',
|
||||
matrix.dbal-version || 'Ø',
|
||||
matrix.extension || 'Ø'
|
||||
) }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
needs: "phpunit-smoke-check"
|
||||
|
||||
@@ -203,7 +240,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
@@ -220,7 +257,7 @@ jobs:
|
||||
if: "${{ matrix.dbal-version != 'default' }}"
|
||||
|
||||
- name: "Install dependencies with Composer"
|
||||
uses: "ramsey/composer-install@v3"
|
||||
uses: "ramsey/composer-install@v4"
|
||||
with:
|
||||
composer-options: "--ignore-platform-req=php+"
|
||||
|
||||
@@ -228,14 +265,20 @@ jobs:
|
||||
run: "vendor/bin/phpunit -c ci/github/phpunit/pdo_pgsql.xml --coverage-clover=coverage.xml"
|
||||
|
||||
- name: "Upload coverage file"
|
||||
uses: "actions/upload-artifact@v5"
|
||||
uses: "actions/upload-artifact@v7"
|
||||
with:
|
||||
name: "${{ github.job }}-${{ matrix.postgres-version }}-${{ matrix.php-version }}-${{ matrix.dbal-version }}-${{ matrix.extension }}-coverage"
|
||||
path: "coverage.xml"
|
||||
|
||||
|
||||
phpunit-mariadb:
|
||||
name: "PHPUnit with MariaDB"
|
||||
name: >
|
||||
${{ format('MariaDB {0} - PHP {1} - DBAL {2} - ext. {3}',
|
||||
matrix.mariadb-version || 'Ø',
|
||||
matrix.php-version || 'Ø',
|
||||
matrix.dbal-version || 'Ø',
|
||||
matrix.extension || 'Ø'
|
||||
) }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
needs: "phpunit-smoke-check"
|
||||
|
||||
@@ -271,7 +314,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
@@ -288,7 +331,7 @@ jobs:
|
||||
extensions: "${{ matrix.extension }}"
|
||||
|
||||
- name: "Install dependencies with Composer"
|
||||
uses: "ramsey/composer-install@v3"
|
||||
uses: "ramsey/composer-install@v4"
|
||||
with:
|
||||
composer-options: "--ignore-platform-req=php+"
|
||||
|
||||
@@ -296,14 +339,20 @@ jobs:
|
||||
run: "vendor/bin/phpunit -c ci/github/phpunit/${{ matrix.extension }}.xml --coverage-clover=coverage.xml"
|
||||
|
||||
- name: "Upload coverage file"
|
||||
uses: "actions/upload-artifact@v5"
|
||||
uses: "actions/upload-artifact@v7"
|
||||
with:
|
||||
name: "${{ github.job }}-${{ matrix.mariadb-version }}-${{ matrix.extension }}-${{ matrix.php-version }}-${{ matrix.dbal-version }}-coverage"
|
||||
path: "coverage.xml"
|
||||
|
||||
|
||||
phpunit-mysql:
|
||||
name: "PHPUnit with MySQL"
|
||||
name: >
|
||||
${{ format('MySQL {0} - PHP {1} - DBAL {2} - ext. {3}',
|
||||
matrix.mysql-version || 'Ø',
|
||||
matrix.php-version || 'Ø',
|
||||
matrix.dbal-version || 'Ø',
|
||||
matrix.extension || 'Ø'
|
||||
) }}
|
||||
runs-on: "ubuntu-22.04"
|
||||
needs: "phpunit-smoke-check"
|
||||
|
||||
@@ -347,7 +396,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
@@ -364,7 +413,7 @@ jobs:
|
||||
if: "${{ matrix.dbal-version != 'default' }}"
|
||||
|
||||
- name: "Install dependencies with Composer"
|
||||
uses: "ramsey/composer-install@v3"
|
||||
uses: "ramsey/composer-install@v4"
|
||||
with:
|
||||
composer-options: "--ignore-platform-req=php+"
|
||||
|
||||
@@ -393,7 +442,7 @@ jobs:
|
||||
ENABLE_SECOND_LEVEL_CACHE: 1
|
||||
|
||||
- name: "Upload coverage files"
|
||||
uses: "actions/upload-artifact@v5"
|
||||
uses: "actions/upload-artifact@v7"
|
||||
with:
|
||||
name: "${{ github.job }}-${{ matrix.mysql-version }}-${{ matrix.extension }}-${{ matrix.php-version }}-${{ matrix.dbal-version }}-coverage"
|
||||
path: "coverage*.xml"
|
||||
@@ -411,17 +460,17 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- name: "Download coverage files"
|
||||
uses: "actions/download-artifact@v6"
|
||||
uses: "actions/download-artifact@v8"
|
||||
with:
|
||||
path: "reports"
|
||||
|
||||
- name: "Upload to Codecov"
|
||||
uses: "codecov/codecov-action@v5"
|
||||
uses: "codecov/codecov-action@v6"
|
||||
with:
|
||||
directory: reports
|
||||
env:
|
||||
|
||||
@@ -17,4 +17,4 @@ on:
|
||||
jobs:
|
||||
documentation:
|
||||
name: "Documentation"
|
||||
uses: "doctrine/.github/.github/workflows/documentation.yml@12.1.0"
|
||||
uses: "doctrine/.github/.github/workflows/documentation.yml@14.0.0"
|
||||
|
||||
@@ -36,7 +36,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
@@ -48,7 +48,7 @@ jobs:
|
||||
ini-values: "zend.assertions=1, apc.enable_cli=1"
|
||||
|
||||
- name: "Install dependencies with Composer"
|
||||
uses: "ramsey/composer-install@v3"
|
||||
uses: "ramsey/composer-install@v4"
|
||||
|
||||
- name: "Run PHPBench"
|
||||
run: "vendor/bin/phpbench run --report=default"
|
||||
|
||||
@@ -7,7 +7,7 @@ on:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@12.1.0"
|
||||
uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@14.0.0"
|
||||
secrets:
|
||||
GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
|
||||
GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
|
||||
|
||||
@@ -35,7 +35,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: "Checkout code"
|
||||
uses: "actions/checkout@v5"
|
||||
uses: "actions/checkout@v6"
|
||||
|
||||
- name: Install PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
@@ -50,7 +50,7 @@ jobs:
|
||||
|
||||
|
||||
- name: Install dependencies with Composer
|
||||
uses: ramsey/composer-install@v2
|
||||
uses: ramsey/composer-install@v4
|
||||
|
||||
- name: Run static analysis with phpstan/phpstan
|
||||
run: "vendor/bin/phpstan analyse -c ${{ matrix.config }} --error-format=checkstyle | cs2pr"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
| [4.0.x][4.0] | [3.6.x][3.6] | [3.5.x][3.5] | [2.21.x][2.21] | [2.20.x][2.20] |
|
||||
| [4.0.x][4.0] | [3.7.x][3.7] | [3.6.x][3.6] | [2.21.x][2.21] | [2.20.x][2.20] |
|
||||
|:------------------------------------------------------:|:------------------------------------------------------:|:------------------------------------------------------:|:--------------------------------------------------------:|:--------------------------------------------------------:|
|
||||
| [![Build status][4.0 image]][4.0 workflow] | [![Build status][3.6 image]][3.6 workflow] | [![Build status][3.5 image]][3.5 workflow] | [![Build status][2.21 image]][2.21 workflow] | [![Build status][2.20 image]][2.20 workflow] |
|
||||
| [![Coverage Status][4.0 coverage image]][4.0 coverage] | [![Coverage Status][3.6 coverage image]][3.6 coverage] | [![Coverage Status][3.5 coverage image]][3.5 coverage] | [![Coverage Status][2.21 coverage image]][2.21 coverage] | [![Coverage Status][2.20 coverage image]][2.20 coverage] |
|
||||
| [![Build status][4.0 image]][4.0 workflow] | [![Build status][3.7 image]][3.7 workflow] | [![Build status][3.6 image]][3.6 workflow] | [![Build status][2.21 image]][2.21 workflow] | [![Build status][2.20 image]][2.20 workflow] |
|
||||
| [![Coverage Status][4.0 coverage image]][4.0 coverage] | [![Coverage Status][3.7 coverage image]][3.7 coverage] | [![Coverage Status][3.6 coverage image]][3.6 coverage] | [![Coverage Status][2.21 coverage image]][2.21 coverage] | [![Coverage Status][2.20 coverage image]][2.20 coverage] |
|
||||
|
||||
Doctrine ORM is an object-relational mapper for PHP 8.1+ that provides transparent persistence
|
||||
for PHP objects. It sits on top of a powerful database abstraction layer (DBAL). One of its key features
|
||||
@@ -21,16 +21,16 @@ without requiring unnecessary code duplication.
|
||||
[4.0 workflow]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml?query=branch%3A4.0.x
|
||||
[4.0 coverage image]: https://codecov.io/gh/doctrine/orm/branch/4.0.x/graph/badge.svg
|
||||
[4.0 coverage]: https://codecov.io/gh/doctrine/orm/branch/4.0.x
|
||||
[3.7 image]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml/badge.svg?branch=3.7.x
|
||||
[3.7]: https://github.com/doctrine/orm/tree/3.7.x
|
||||
[3.7 workflow]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml?query=branch%3A3.7.x
|
||||
[3.7 coverage image]: https://codecov.io/gh/doctrine/orm/branch/3.7.x/graph/badge.svg
|
||||
[3.7 coverage]: https://codecov.io/gh/doctrine/orm/branch/3.7.x
|
||||
[3.6 image]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml/badge.svg?branch=3.6.x
|
||||
[3.6]: https://github.com/doctrine/orm/tree/3.6.x
|
||||
[3.6 workflow]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml?query=branch%3A3.6.x
|
||||
[3.6 coverage image]: https://codecov.io/gh/doctrine/orm/branch/3.6.x/graph/badge.svg
|
||||
[3.6 coverage]: https://codecov.io/gh/doctrine/orm/branch/3.6.x
|
||||
[3.5 image]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml/badge.svg?branch=3.5.x
|
||||
[3.5]: https://github.com/doctrine/orm/tree/3.5.x
|
||||
[3.5 workflow]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml?query=branch%3A3.5.x
|
||||
[3.5 coverage image]: https://codecov.io/gh/doctrine/orm/branch/3.5.x/graph/badge.svg
|
||||
[3.5 coverage]: https://codecov.io/gh/doctrine/orm/branch/3.5.x
|
||||
[2.21 image]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml/badge.svg?branch=2.21.x
|
||||
[2.21]: https://github.com/doctrine/orm/tree/2.21.x
|
||||
[2.21 workflow]: https://github.com/doctrine/orm/actions/workflows/continuous-integration.yml?query=branch%3A2.21.x
|
||||
|
||||
+180
-1
@@ -27,6 +27,185 @@ At this point, we recommend upgrading to PHP 8.4 first and then directly from
|
||||
ORM 2.19 to 3.5 and up so that you can skip the lazy ghost proxy generation
|
||||
and directly start using native lazy objects.
|
||||
|
||||
# Upgrade to 3.7
|
||||
|
||||
## Conditional breaking changes
|
||||
|
||||
3.7 adds support for `doctrine/collections` 3. If you upgrade to that version
|
||||
of `doctrine/collections`, there are breaking changes in `doctrine/orm` as well,
|
||||
because of cross-package inheritance and type declarations.
|
||||
|
||||
Most notably, `Doctrine\ORM\PersistentCollection::add` no longer returns a boolean:
|
||||
|
||||
```diff
|
||||
- public function add(mixed $value): bool
|
||||
+ public function add(mixed $value): void
|
||||
```
|
||||
|
||||
That method always returned `true`, so you can safely stop using the return
|
||||
value before upgrading.
|
||||
|
||||
Also, if you extend `Doctrine\ORM\Persisters\SqlValueVisitor`, you need to
|
||||
ensure the following methods have a return type in your subclasses:
|
||||
|
||||
- `walkComparison()`
|
||||
- `walkCompositeExpression()`
|
||||
- `walkValue()`
|
||||
|
||||
## Deprecate `EventManager` return type in `EntityManager` methods
|
||||
|
||||
The return type of the following methods has been changed from
|
||||
`Doctrine\Common\EventManager` to `Doctrine\Common\EventManagerInterface`:
|
||||
|
||||
- `Doctrine\ORM\Decorator\EntityManagerDecorator::getEventManager()`
|
||||
- `Doctrine\ORM\EntityManager::getEventManager()`
|
||||
- `Doctrine\ORM\EntityManagerInterface::getEventManager()`
|
||||
|
||||
All three methods continue to return an instance of `EventManager`, however
|
||||
relying on that is deprecated and will no longer be the guaranteed in 4.0.
|
||||
|
||||
# Upgrade to 3.6
|
||||
|
||||
## Deprecate using string expression for default values in mappings
|
||||
|
||||
Using a string expression for default values in field mappings is deprecated.
|
||||
Use `Doctrine\DBAL\Schema\DefaultExpression` instances instead.
|
||||
|
||||
Here is how to address this deprecation when mapping entities using PHP attributes:
|
||||
|
||||
```diff
|
||||
use DateTime;
|
||||
+use Doctrine\DBAL\Schema\DefaultExpression\CurrentDate;
|
||||
+use Doctrine\DBAL\Schema\DefaultExpression\CurrentTime;
|
||||
+use Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp;
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
|
||||
#[ORM\Entity]
|
||||
final class TimeEntity
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\Column]
|
||||
public int $id;
|
||||
|
||||
- #[ORM\Column(options: ['default' => 'CURRENT_TIMESTAMP'], insertable: false, updatable: false)]
|
||||
+ #[ORM\Column(options: ['default' => new CurrentTimestamp()], insertable: false, updatable: false)]
|
||||
public DateTime $createdAt;
|
||||
|
||||
- #[ORM\Column(options: ['default' => 'CURRENT_TIME'], insertable: false, updatable: false)]
|
||||
+ #[ORM\Column(options: ['default' => new CurrentTime()], insertable: false, updatable: false)]
|
||||
public DateTime $createdTime;
|
||||
|
||||
- #[ORM\Column(options: ['default' => 'CURRENT_DATE'], insertable: false, updatable: false)]
|
||||
+ #[ORM\Column(options: ['default' => new CurrentDate()], insertable: false, updatable: false)]
|
||||
public DateTime $createdDate;
|
||||
}
|
||||
```
|
||||
|
||||
Here is how to do the same when mapping entities using XML:
|
||||
|
||||
```diff
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
|
||||
https://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
|
||||
|
||||
<entity name="Doctrine\Tests\ORM\Functional\XmlTimeEntity">
|
||||
<id name="id" type="integer" column="id">
|
||||
<generator strategy="AUTO"/>
|
||||
</id>
|
||||
|
||||
<field name="createdAt" type="datetime" insertable="false" updatable="false">
|
||||
<options>
|
||||
- <option name="default">CURRENT_TIMESTAMP</option>
|
||||
+ <option name="default">
|
||||
+ <object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp"/>
|
||||
+ </option>
|
||||
</options>
|
||||
</field>
|
||||
|
||||
<field name="createdAtImmutable" type="datetime_immutable" insertable="false" updatable="false">
|
||||
<options>
|
||||
- <option name="default">CURRENT_TIMESTAMP</option>
|
||||
+ <option name="default">
|
||||
+ <object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp"/>
|
||||
+ </option>
|
||||
</options>
|
||||
</field>
|
||||
|
||||
<field name="createdTime" type="time" insertable="false" updatable="false">
|
||||
<options>
|
||||
- <option name="default">CURRENT_TIME</option>
|
||||
+ <option name="default">
|
||||
+ <object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentTime"/>
|
||||
+ </option>
|
||||
</options>
|
||||
</field>
|
||||
<field name="createdDate" type="date" insertable="false" updatable="false">
|
||||
<options>
|
||||
- <option name="default">CURRENT_DATE</option>
|
||||
+ <option name="default">
|
||||
+ <object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentDate"/>
|
||||
+ </option>
|
||||
</options>
|
||||
</field>
|
||||
</entity>
|
||||
</doctrine-mapping>
|
||||
```
|
||||
|
||||
|
||||
## Deprecate `FieldMapping::$default`
|
||||
|
||||
The `default` property of `Doctrine\ORM\Mapping\FieldMapping` is deprecated and
|
||||
will be removed in 4.0. Instead, use `FieldMapping::$options['default']`.
|
||||
|
||||
## Deprecate specifying `nullable` on columns that end up being used in a primary key
|
||||
|
||||
Specifying `nullable` on join columns that are part of a primary key is
|
||||
deprecated and will be an error in 4.0.
|
||||
|
||||
This can happen when using a join column mapping together with an id mapping,
|
||||
or when using a join column mapping or an inverse join column mapping on a
|
||||
many-to-many relationship.
|
||||
|
||||
```diff
|
||||
class User
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\Column(type: 'integer')]
|
||||
private int $id;
|
||||
|
||||
#[ORM\Id]
|
||||
#[ORM\ManyToOne(targetEntity: Family::class, inversedBy: 'users')]
|
||||
- #[ORM\JoinColumn(name: 'family_id', referencedColumnName: 'id', nullable: true)]
|
||||
+ #[ORM\JoinColumn(name: 'family_id', referencedColumnName: 'id')]
|
||||
private ?Family $family;
|
||||
|
||||
#[ORM\ManyToMany(targetEntity: Group::class)]
|
||||
#[ORM\JoinTable(name: 'user_group')]
|
||||
- #[ORM\JoinColumn(name: 'user_id', referencedColumnName: 'id', nullable: true)]
|
||||
- #[ORM\InverseJoinColumn(name: 'group_id', referencedColumnName: 'id', nullable: true)]
|
||||
+ #[ORM\JoinColumn(name: 'user_id', referencedColumnName: 'id')]
|
||||
+ #[ORM\InverseJoinColumn(name: 'group_id', referencedColumnName: 'id')]
|
||||
private Collection $groups;
|
||||
}
|
||||
```
|
||||
|
||||
## Deprecate `Doctrine\ORM\QueryBuilder::add('join', ...)` with a list of join parts
|
||||
|
||||
Using `Doctrine\ORM\QueryBuilder::add('join', ...)` with a list of join parts
|
||||
is deprecated in favor of using an associative array of join parts with the
|
||||
root alias as key.
|
||||
|
||||
## Deprecate using the `WITH` keyword for arbitrary DQL joins
|
||||
|
||||
Using the `WITH` keyword to specify the condition for an arbitrary DQL join is
|
||||
deprecated in favor of using the `ON` keyword (similar to the SQL syntax for
|
||||
joins).
|
||||
The `WITH` keyword is now meant to be used only for filtering conditions in
|
||||
association joins.
|
||||
|
||||
# Upgrade to 3.5
|
||||
|
||||
See the General notes to upgrading to 3.x versions above.
|
||||
@@ -2159,7 +2338,7 @@ from 2.0 have to configure the annotation driver if they don't use `Configuratio
|
||||
|
||||
## Scalar mappings can now be omitted from DQL result
|
||||
|
||||
You are now allowed to mark scalar SELECT expressions as HIDDEN an they are not hydrated anymore.
|
||||
You are now allowed to mark scalar SELECT expressions as HIDDEN and they are not hydrated anymore.
|
||||
Example:
|
||||
|
||||
SELECT u, SUM(a.id) AS HIDDEN numArticles FROM User u LEFT JOIN u.Articles a ORDER BY numArticles DESC HAVING numArticles > 10
|
||||
|
||||
+70
-54
@@ -1,19 +1,76 @@
|
||||
{
|
||||
"name": "doctrine/orm",
|
||||
"type": "library",
|
||||
"description": "Object-Relational-Mapper for PHP",
|
||||
"keywords": ["orm", "database"],
|
||||
"homepage": "https://www.doctrine-project.org/projects/orm.html",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{"name": "Guilherme Blanco", "email": "guilhermeblanco@gmail.com"},
|
||||
{"name": "Roman Borschel", "email": "roman@code-factory.org"},
|
||||
{"name": "Benjamin Eberlei", "email": "kontakt@beberlei.de"},
|
||||
{"name": "Jonathan Wage", "email": "jonwage@gmail.com"},
|
||||
{"name": "Marco Pivetta", "email": "ocramius@gmail.com"}
|
||||
"type": "library",
|
||||
"keywords": [
|
||||
"orm",
|
||||
"database"
|
||||
],
|
||||
"scripts": {
|
||||
"docs": "composer --working-dir docs update && ./docs/vendor/bin/build-docs.sh @additional_args"
|
||||
"authors": [
|
||||
{
|
||||
"name": "Guilherme Blanco",
|
||||
"email": "guilhermeblanco@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "Roman Borschel",
|
||||
"email": "roman@code-factory.org"
|
||||
},
|
||||
{
|
||||
"name": "Benjamin Eberlei",
|
||||
"email": "kontakt@beberlei.de"
|
||||
},
|
||||
{
|
||||
"name": "Jonathan Wage",
|
||||
"email": "jonwage@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "Marco Pivetta",
|
||||
"email": "ocramius@gmail.com"
|
||||
}
|
||||
],
|
||||
"homepage": "https://www.doctrine-project.org/projects/orm.html",
|
||||
"require": {
|
||||
"php": "^8.1",
|
||||
"ext-ctype": "*",
|
||||
"composer-runtime-api": "^2",
|
||||
"doctrine/collections": "^2.2 || ^3",
|
||||
"doctrine/dbal": "^3.8.2 || ^4",
|
||||
"doctrine/deprecations": "^0.5.3 || ^1",
|
||||
"doctrine/event-manager": "^2.1.1",
|
||||
"doctrine/inflector": "^1.4 || ^2.0",
|
||||
"doctrine/instantiator": "^1.3 || ^2",
|
||||
"doctrine/lexer": "^3",
|
||||
"doctrine/persistence": "^3.3.1 || ^4",
|
||||
"psr/cache": "^1 || ^2 || ^3",
|
||||
"symfony/console": "^5.4 || ^6.0 || ^7.0 || ^8.0",
|
||||
"symfony/var-exporter": "^6.3.9 || ^7.0 || ^8.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"doctrine/coding-standard": "^14.0",
|
||||
"phpbench/phpbench": "^1.0",
|
||||
"phpstan/extension-installer": "^1.4",
|
||||
"phpstan/phpstan": "2.1.23",
|
||||
"phpstan/phpstan-deprecation-rules": "^2",
|
||||
"phpunit/phpunit": "^10.5.0 || ^11.5",
|
||||
"psr/log": "^1 || ^2 || ^3",
|
||||
"symfony/cache": "^5.4 || ^6.2 || ^7.0 || ^8.0"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-dom": "Provides support for XSD validation for XML mapping files",
|
||||
"symfony/cache": "Provides cache support for Setup Tool with doctrine/cache 2.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Doctrine\\ORM\\": "src"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Doctrine\\Performance\\": "tests/Performance",
|
||||
"Doctrine\\StaticAnalysis\\": "tests/StaticAnalysis",
|
||||
"Doctrine\\Tests\\": "tests/Tests"
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
@@ -23,48 +80,7 @@
|
||||
},
|
||||
"sort-packages": true
|
||||
},
|
||||
"require": {
|
||||
"php": "^8.1",
|
||||
"composer-runtime-api": "^2",
|
||||
"ext-ctype": "*",
|
||||
"doctrine/collections": "^2.2",
|
||||
"doctrine/dbal": "^3.8.2 || ^4",
|
||||
"doctrine/deprecations": "^0.5.3 || ^1",
|
||||
"doctrine/event-manager": "^1.2 || ^2",
|
||||
"doctrine/inflector": "^1.4 || ^2.0",
|
||||
"doctrine/instantiator": "^1.3 || ^2",
|
||||
"doctrine/lexer": "^3",
|
||||
"doctrine/persistence": "^3.3.1 || ^4",
|
||||
"psr/cache": "^1 || ^2 || ^3",
|
||||
"symfony/console": "^5.4 || ^6.0 || ^7.0",
|
||||
"symfony/var-exporter": "^6.3.9 || ^7.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"doctrine/coding-standard": "^14.0",
|
||||
"phpbench/phpbench": "^1.0",
|
||||
"phpdocumentor/guides-cli": "^1.4",
|
||||
"phpstan/extension-installer": "^1.4",
|
||||
"phpstan/phpstan": "2.1.22",
|
||||
"phpstan/phpstan-deprecation-rules": "^2",
|
||||
"phpunit/phpunit": "^10.5.0 || ^11.5",
|
||||
"psr/log": "^1 || ^2 || ^3",
|
||||
"symfony/cache": "^5.4 || ^6.2 || ^7.0"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-dom": "Provides support for XSD validation for XML mapping files",
|
||||
"symfony/cache": "Provides cache support for Setup Tool with doctrine/cache 2.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": { "Doctrine\\ORM\\": "src" }
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Doctrine\\Tests\\": "tests/Tests",
|
||||
"Doctrine\\StaticAnalysis\\": "tests/StaticAnalysis",
|
||||
"Doctrine\\Performance\\": "tests/Performance"
|
||||
}
|
||||
},
|
||||
"archive": {
|
||||
"exclude": ["!vendor", "tests", "*phpunit.xml", "build.xml", "build.properties", "composer.phar", "vendor/satooshi", "lib/vendor", "*.swp"]
|
||||
"scripts": {
|
||||
"docs": "composer --working-dir docs update && ./docs/vendor/bin/build-docs.sh @additional_args"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -40,7 +40,8 @@ Now this is all awfully technical, so let me come to some use-cases
|
||||
fast to keep you motivated. Using walker implementation you can for
|
||||
example:
|
||||
|
||||
|
||||
- Modify the Output walker to get the raw SQL via ``Query->getSQL()``
|
||||
with interpolated parameters.
|
||||
- Modify the AST to generate a Count Query to be used with a
|
||||
paginator for any given DQL query.
|
||||
- Modify the Output Walker to generate vendor-specific SQL
|
||||
@@ -50,7 +51,7 @@ example:
|
||||
- Modify the Output walker to pretty print the SQL for debugging
|
||||
purposes.
|
||||
|
||||
In this cookbook-entry I will show examples of the first two
|
||||
In this cookbook-entry I will show examples of the first three
|
||||
points. There are probably much more use-cases.
|
||||
|
||||
Generic count query for pagination
|
||||
@@ -223,3 +224,39 @@ huge benefits with using vendor specific features. This would still
|
||||
allow you write DQL queries instead of NativeQueries to make use of
|
||||
vendor specific features.
|
||||
|
||||
Modifying the Output Walker to get the raw SQL with interpolated parameters
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
Sometimes we may want to log or trace the raw SQL being generated from its DQL
|
||||
for profiling slow queries afterwards or audit queries that changed many rows
|
||||
``$query->getSQL()`` will give us the prepared statement being passed to database
|
||||
with all values of SQL parameters being replaced by positional ``?`` or named ``:name``
|
||||
as parameters are interpolated into prepared statements by the database while executing the SQL.
|
||||
``$query->getParameters()`` will give us details about SQL parameters that we've provided.
|
||||
So we can create an output walker to interpolate all SQL parameters that will be
|
||||
passed into prepared statement in PHP before database handle them internally:
|
||||
|
||||
.. literalinclude:: dql-custom-walkers/InterpolateParametersSQLOutputWalker.php
|
||||
:language: php
|
||||
|
||||
Then you may get the raw SQL with this output walker:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
$query
|
||||
->where('t.int IN (:ints)')->setParameter(':ints', [1, 2])
|
||||
->orWhere('t.string IN (?0)')->setParameter(0, ['3', '4'])
|
||||
->orWhere("t.bool = ?1")->setParameter('?1', true)
|
||||
->orWhere("t.string = :string")->setParameter(':string', 'ABC')
|
||||
->setHint(\Doctrine\ORM\Query::HINT_CUSTOM_OUTPUT_WALKER, InterpolateParametersSQLOutputWalker::class)
|
||||
->getSQL();
|
||||
|
||||
The where clause of the returned SQL should be like:
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
WHERE t0_.int IN (1, 2)
|
||||
OR t0_.string IN ('3', '4')
|
||||
OR t0_.bool = 1
|
||||
OR t0_.string = 'ABC'
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
use Doctrine\DBAL\ArrayParameterType;
|
||||
use Doctrine\DBAL\ParameterType;
|
||||
use Doctrine\DBAL\Types\BooleanType;
|
||||
use Doctrine\DBAL\Types\Exception\ValueNotConvertible;
|
||||
use Doctrine\DBAL\Types\Type;
|
||||
use Doctrine\ORM\Query\AST;
|
||||
use Doctrine\ORM\Query\SqlOutputWalker;
|
||||
|
||||
class InterpolateParametersSQLOutputWalker extends SqlOutputWalker
|
||||
{
|
||||
/** {@inheritdoc} */
|
||||
public function walkInputParameter(AST\InputParameter $inputParam): string
|
||||
{
|
||||
$parameter = $this->getQuery()->getParameter($inputParam->name);
|
||||
if ($parameter === null) {
|
||||
return '?';
|
||||
}
|
||||
|
||||
$value = $parameter->getValue();
|
||||
/** @var ParameterType|ArrayParameterType|int|string $typeName */
|
||||
/** @see \Doctrine\ORM\Query\ParameterTypeInferer::inferType() */
|
||||
$typeName = $parameter->getType();
|
||||
$platform = $this->getConnection()->getDatabasePlatform();
|
||||
$processParameterType = static fn(ParameterType $type) => static fn($value): string =>
|
||||
(match ($type) { /** @see Type::getBindingType() */
|
||||
ParameterType::NULL => 'NULL',
|
||||
ParameterType::INTEGER => $value,
|
||||
ParameterType::BOOLEAN => (new BooleanType())->convertToDatabaseValue($value, $platform),
|
||||
ParameterType::STRING, ParameterType::ASCII => $platform->quoteStringLiteral($value),
|
||||
default => throw new ValueNotConvertible($value, $type->name)
|
||||
});
|
||||
|
||||
if (is_string($typeName) && Type::hasType($typeName)) {
|
||||
return Type::getType($typeName)->convertToDatabaseValue($value, $platform);
|
||||
}
|
||||
if ($typeName instanceof ParameterType) {
|
||||
return $processParameterType($typeName)($value);
|
||||
}
|
||||
if ($typeName instanceof ArrayParameterType && is_array($value)) {
|
||||
$type = ArrayParameterType::toElementParameterType($typeName);
|
||||
return implode(', ', array_map($processParameterType($type), $value));
|
||||
}
|
||||
|
||||
throw new ValueNotConvertible($value, $typeName);
|
||||
}
|
||||
}
|
||||
@@ -13,7 +13,6 @@ If this documentation is not helping to answer questions you have about
|
||||
Doctrine ORM don't panic. You can get help from different sources:
|
||||
|
||||
- There is a :doc:`FAQ <reference/faq>` with answers to frequent questions.
|
||||
- The `Doctrine Mailing List <https://groups.google.com/group/doctrine-user>`_
|
||||
- Slack chat room `#orm <https://www.doctrine-project.org/slack>`_
|
||||
- Report a bug on `GitHub <https://github.com/doctrine/orm/issues>`_.
|
||||
- On `StackOverflow <https://stackoverflow.com/questions/tagged/doctrine-orm>`_
|
||||
|
||||
@@ -29,7 +29,7 @@ steps of configuration.
|
||||
|
||||
$config = new Configuration;
|
||||
$config->setMetadataCache($metadataCache);
|
||||
$driverImpl = new AttributeDriver(['/path/to/lib/MyProject/Entities'], true);
|
||||
$driverImpl = new AttributeDriver(['/path/to/lib/MyProject/Entities']);
|
||||
$config->setMetadataDriverImpl($driverImpl);
|
||||
$config->setQueryCache($queryCache);
|
||||
|
||||
@@ -156,15 +156,59 @@ The attribute driver can be injected in the ``Doctrine\ORM\Configuration``:
|
||||
<?php
|
||||
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
|
||||
|
||||
$driverImpl = new AttributeDriver(['/path/to/lib/MyProject/Entities'], true);
|
||||
$driverImpl = new AttributeDriver(['/path/to/lib/MyProject/Entities']);
|
||||
$config->setMetadataDriverImpl($driverImpl);
|
||||
|
||||
The path information to the entities is required for the attribute
|
||||
driver, because otherwise mass-operations on all entities through
|
||||
the console could not work correctly. All of metadata drivers
|
||||
accept either a single directory as a string or an array of
|
||||
directories. With this feature a single driver can support multiple
|
||||
directories of Entities.
|
||||
the console could not work correctly. Metadata drivers can accept either
|
||||
a single directory as a string or an array of directories.
|
||||
|
||||
AttributeDriver also accepts ``Doctrine\Persistence\Mapping\Driver\ClassLocator``,
|
||||
allowing one to customize file discovery logic. You may choose to use Symfony Finder, or
|
||||
utilize directory scan with ``FileClassLocator::createFromDirectories()``:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
|
||||
use Doctrine\Persistence\Mapping\Driver\FileClassLocator;
|
||||
|
||||
$paths = ['/path/to/lib/MyProject/Entities'];
|
||||
$classLocator = FileClassLocator::createFromDirectories($paths);
|
||||
|
||||
$driverImpl = new AttributeDriver($classLocator);
|
||||
$config->setMetadataDriverImpl($driverImpl);
|
||||
|
||||
With this feature, you're empowered to provide a fine-grained iterator of only necessary
|
||||
files to the Driver. For example, if you are using Vertical Slice architecture, you can
|
||||
exclude ``*Test.php``, ``*Controller.php``, ``*Service.php``, etc.:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
use Symfony\Component\Finder\Finder;
|
||||
|
||||
$finder = new Finder()->files()->in($paths)
|
||||
->name('*.php')
|
||||
->notName(['*Test.php', '*Controller.php', '*Service.php']);
|
||||
|
||||
$classLocator = new FileClassLocator($finder);
|
||||
|
||||
If you know the list of class names you want to track, use
|
||||
``Doctrine\Persistence\Mapping\Driver\ClassNames``:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
use Doctrine\Persistence\Mapping\Driver\ClassNames;
|
||||
use App\Entity\{Article, Book};
|
||||
|
||||
$entityClasses = [Article::class, Book::class];
|
||||
$classLocator = new ClassNames($entityClasses);
|
||||
|
||||
$driverImpl = new AttributeDriver($classLocator);
|
||||
$config->setMetadataDriverImpl($driverImpl);
|
||||
|
||||
Metadata Cache (**RECOMMENDED**)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -668,11 +668,6 @@ and in the Context of a :ref:`#[ManyToMany] <attrref_manytomany>`. If this attri
|
||||
are missing they will be computed considering the field's name and the current
|
||||
:doc:`naming strategy <namingstrategy>`.
|
||||
|
||||
The ``#[InverseJoinColumn]`` is the same as ``#[JoinColumn]`` and is used in the context
|
||||
of a ``#[ManyToMany]`` attribute declaration to specifiy the details of the join table's
|
||||
column information used for the join to the inverse entity. This is only required
|
||||
on PHP 8.0, where nested attributes are not yet supported.
|
||||
|
||||
Optional parameters:
|
||||
|
||||
- **name**: Column name that holds the foreign key identifier for
|
||||
|
||||
@@ -168,7 +168,7 @@ Here is a complete list of ``Column``s attributes (all optional):
|
||||
- ``insertable`` (default: ``true``): Whether the column should be inserted.
|
||||
- ``updatable`` (default: ``true``): Whether the column should be updated.
|
||||
- ``generated`` (default: ``null``): Whether the generated strategy should be ``'NEVER'``, ``'INSERT'`` and ``ALWAYS``.
|
||||
- ``enumType`` (requires PHP 8.1 and ``doctrine/orm`` 2.11): The PHP enum class name to convert the database value into.
|
||||
- ``enumType`` (requires PHP 8.1 and ``doctrine/orm`` 2.11): The PHP enum class name to convert the database value into. See :ref:`reference-enum-mapping`.
|
||||
- ``precision`` (default: 0): The precision for a decimal (exact numeric) column
|
||||
(applies only for decimal column),
|
||||
which is the maximum number of digits that are stored for the values.
|
||||
@@ -182,6 +182,37 @@ Here is a complete list of ``Column``s attributes (all optional):
|
||||
- ``options``: Key-value pairs of options that get passed
|
||||
to the underlying database platform when generating DDL statements.
|
||||
|
||||
Specifying default values
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
While it is possible to specify default values for properties in your
|
||||
PHP class, Doctrine also allows you to specify default values for
|
||||
database columns using the ``default`` key in the ``options`` array of
|
||||
the ``Column`` attribute.
|
||||
|
||||
When using XML, you can specify object instances using the ``<object>``
|
||||
element:
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<field name="createdAt" type="datetime" insertable="false" updatable="false">
|
||||
<options>
|
||||
<option name="default">
|
||||
<object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp"/>
|
||||
</option>
|
||||
</options>
|
||||
</field>
|
||||
|
||||
The ``<object>`` element requires a ``class`` attribute specifying the
|
||||
fully qualified class name to instantiate.
|
||||
|
||||
.. configuration-block::
|
||||
.. literalinclude:: basic-mapping/DefaultValues.php
|
||||
:language: attribute
|
||||
|
||||
.. literalinclude:: basic-mapping/default-values.xml
|
||||
:language: xml
|
||||
|
||||
.. _reference-php-mapping-types:
|
||||
|
||||
PHP Types Mapping
|
||||
@@ -290,6 +321,160 @@ that value and raw value are different, you have to use the raw value representa
|
||||
$messageRepository = $entityManager->getRepository(Message::class);
|
||||
$deMessages = $messageRepository->findBy(['language' => 'de']); // Use lower case here for raw value representation
|
||||
|
||||
.. _reference-enum-mapping:
|
||||
|
||||
Mapping PHP Enums
|
||||
-----------------
|
||||
|
||||
.. versionadded:: 2.11
|
||||
|
||||
Doctrine natively supports mapping PHP backed enums to database columns.
|
||||
A backed enum is a PHP enum that the same scalar type (``string`` or ``int``)
|
||||
assigned to each case. Doctrine stores the scalar value in the database and
|
||||
converts it back to the enum instance when hydrating the entity.
|
||||
|
||||
Using ``enumType`` provides three main benefits:
|
||||
|
||||
- **Automatic conversion**: Doctrine handles the conversion in both directions
|
||||
transparently. When loading an entity, scalar values from the database are
|
||||
converted into enum instances. When persisting, enum instances are reduced
|
||||
to their scalar ``->value`` before being sent to the database.
|
||||
- **Type-safety**: Entity properties contain enum instances directly. Your
|
||||
getters return ``Suit`` instead of ``string``, removing the need to call
|
||||
``Suit::from()`` manually.
|
||||
- **Validation**: When a database value does not match any enum case, Doctrine
|
||||
throws a ``MappingException`` during hydration instead of silently returning
|
||||
an invalid value.
|
||||
|
||||
This feature works with all database platforms supported by Doctrine (MySQL,
|
||||
PostgreSQL, SQLite, etc.) as it relies on standard column types (``string``,
|
||||
``integer``, ``json``, ``simple_array``) rather than any vendor-specific enum
|
||||
type.
|
||||
|
||||
.. note::
|
||||
|
||||
This is unrelated to the MySQL-specific ``ENUM`` column type covered in
|
||||
:doc:`the MySQL Enums cookbook entry </cookbook/mysql-enums>`.
|
||||
|
||||
Defining an Enum
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: basic-mapping/Suit.php
|
||||
:language: php
|
||||
|
||||
Only backed enums (``string`` or ``int``) are supported. Unit enums (without
|
||||
a scalar value) cannot be mapped.
|
||||
|
||||
Single-Value Columns
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Use the ``enumType`` option on ``#[Column]`` to map a property to a backed enum.
|
||||
The underlying database column stores the enum's scalar value (``string`` or ``int``).
|
||||
|
||||
.. literalinclude:: basic-mapping/EnumMapping.php
|
||||
:language: php
|
||||
|
||||
When the PHP property is typed with the enum class, Doctrine automatically
|
||||
infers the appropriate column type (``string`` for string-backed enums,
|
||||
``integer`` for int-backed enums) and sets ``enumType``. You can also specify
|
||||
the column ``type`` explicitly.
|
||||
|
||||
Storing Collections of Enums
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can store multiple enum values in a single column by combining ``enumType``
|
||||
with a collection column type: ``json`` or ``simple_array``.
|
||||
|
||||
.. note::
|
||||
|
||||
Automatic type inference does not apply to collection columns. When the
|
||||
PHP property is typed as ``array``, Doctrine cannot detect the enum class.
|
||||
You must specify both ``type`` and ``enumType`` explicitly.
|
||||
|
||||
.. literalinclude:: basic-mapping/EnumCollectionMapping.php
|
||||
:language: php
|
||||
|
||||
With ``json``, the values are stored as a JSON array (e.g. ``["hearts","spades"]``).
|
||||
With ``simple_array``, the values are stored as a comma-separated string
|
||||
(e.g. ``hearts,spades``).
|
||||
|
||||
In both cases, Doctrine converts each element to and from the enum
|
||||
automatically during hydration and persistence.
|
||||
|
||||
.. tip::
|
||||
|
||||
Use ``json`` when enum values may contain commas, when you need to store
|
||||
int-backed enums (as it preserves value types), when the column also
|
||||
stores complex/nested data structures, or when you want to query individual
|
||||
values using database-native JSON operators (e.g. PostgreSQL ``jsonb``).
|
||||
Prefer ``simple_array`` for a compact, human-readable storage of
|
||||
string-backed enums whose values do not contain commas.
|
||||
|
||||
+-------------------+-----------------------------+-------------------------------+
|
||||
| Column type | Database storage | PHP type |
|
||||
+===================+=============================+===============================+
|
||||
| ``string`` | ``hearts`` | ``Suit`` |
|
||||
+-------------------+-----------------------------+-------------------------------+
|
||||
| ``integer`` | ``1`` | ``Priority`` |
|
||||
+-------------------+-----------------------------+-------------------------------+
|
||||
| ``json`` | ``["hearts","spades"]`` | ``array<Suit>`` |
|
||||
+-------------------+-----------------------------+-------------------------------+
|
||||
| ``simple_array`` | ``hearts,spades`` | ``array<Suit>`` |
|
||||
+-------------------+-----------------------------+-------------------------------+
|
||||
|
||||
Nullable Enums
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Enum columns can be nullable. When the database value is ``NULL``, Doctrine
|
||||
preserves it as ``null`` without triggering any validation error.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
#[ORM\Column(type: 'string', nullable: true, enumType: Suit::class)]
|
||||
private Suit|null $suit = null;
|
||||
|
||||
Default Values
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
You can specify a database-level default using an enum case directly in the
|
||||
column options:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
#[ORM\Column(options: ['default' => Suit::Hearts])]
|
||||
public Suit $suit;
|
||||
|
||||
Using Enums in Queries
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Enum instances can be used directly as parameters in DQL, QueryBuilder, and
|
||||
repository methods. Doctrine converts them to their scalar value automatically.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
// QueryBuilder
|
||||
$qb = $em->createQueryBuilder();
|
||||
$qb->select('c')
|
||||
->from(Card::class, 'c')
|
||||
->where('c.suit = :suit')
|
||||
->setParameter('suit', Suit::Clubs);
|
||||
|
||||
// Repository
|
||||
$cards = $em->getRepository(Card::class)->findBy(['suit' => Suit::Clubs]);
|
||||
|
||||
XML Mapping
|
||||
~~~~~~~~~~~
|
||||
|
||||
When using XML mapping, the ``enum-type`` attribute is used on ``<field>``
|
||||
elements:
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<field name="suit" type="string" enum-type="App\Entity\Suit" />
|
||||
|
||||
.. _reference-mapping-types:
|
||||
|
||||
Doctrine Mapping Types
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Entity;
|
||||
|
||||
use DateTime;
|
||||
use Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp;
|
||||
use Doctrine\ORM\Mapping\Column;
|
||||
use Doctrine\ORM\Mapping\Entity;
|
||||
|
||||
#[Entity]
|
||||
class Message
|
||||
{
|
||||
#[Column(options: ['default' => 'Hello World!'])]
|
||||
private string $text;
|
||||
|
||||
#[Column(options: ['default' => new CurrentTimestamp()], insertable: false, updatable: false)]
|
||||
private DateTime $createdAt;
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Entity;
|
||||
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
|
||||
#[ORM\Entity]
|
||||
class Player
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
private int $id;
|
||||
|
||||
/** @var list<Suit> */
|
||||
#[ORM\Column(type: 'json', enumType: Suit::class)]
|
||||
private array $favouriteSuits = [];
|
||||
|
||||
/** @var list<Suit> */
|
||||
#[ORM\Column(type: 'simple_array', enumType: Suit::class)]
|
||||
private array $allowedSuits = [];
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Entity;
|
||||
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
|
||||
#[ORM\Entity]
|
||||
class Card
|
||||
{
|
||||
#[ORM\Id]
|
||||
#[ORM\GeneratedValue]
|
||||
#[ORM\Column]
|
||||
private int $id;
|
||||
|
||||
#[ORM\Column(enumType: Suit::class)]
|
||||
private Suit $suit;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Entity;
|
||||
|
||||
enum Suit: string
|
||||
{
|
||||
case Hearts = 'hearts';
|
||||
case Diamonds = 'diamonds';
|
||||
case Clubs = 'clubs';
|
||||
case Spades = 'spades';
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
<doctrine-mapping>
|
||||
<entity name="Message">
|
||||
<field name="text">
|
||||
<options>
|
||||
<option name="default">Hello World!</option>
|
||||
</options>
|
||||
</field>
|
||||
<field name="createdAt" insertable="false" updatable="false">
|
||||
<options>
|
||||
<option name="default">
|
||||
<object class="Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp"/>
|
||||
</option>
|
||||
</options>
|
||||
</field>
|
||||
</entity>
|
||||
</doctrine-mapping>
|
||||
@@ -490,7 +490,7 @@ where you can generate an arbitrary join with the following syntax:
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
$query = $em->createQuery('SELECT u FROM User u JOIN Banlist b WITH u.email = b.email');
|
||||
$query = $em->createQuery('SELECT u FROM User u JOIN Banlist b ON u.email = b.email');
|
||||
|
||||
With an arbitrary join the result differs from the joins using a mapped property.
|
||||
The result of an arbitrary join is an one dimensional array with a mix of the entity from the ``SELECT``
|
||||
@@ -513,13 +513,15 @@ it loads all the related ``Banlist`` objects corresponding to this ``User``. Thi
|
||||
when the DQL is switched to an arbitrary join.
|
||||
|
||||
.. note::
|
||||
The differences between WHERE, WITH and HAVING clauses may be
|
||||
The differences between WHERE, WITH, ON and HAVING clauses may be
|
||||
confusing.
|
||||
|
||||
- WHERE is applied to the results of an entire query
|
||||
- WITH is applied to a join as an additional condition. For
|
||||
arbitrary joins (SELECT f, b FROM Foo f, Bar b WITH f.id = b.id)
|
||||
the WITH is required, even if it is 1 = 1
|
||||
- ON is applied to arbitrary joins as the join condition. For
|
||||
arbitrary joins (SELECT f, b FROM Foo f, Bar b ON f.id = b.id)
|
||||
the ON is required, even if it is 1 = 1. WITH is also
|
||||
supported as alternative keyword for that case for BC reasons.
|
||||
- WITH is applied to an association join as an additional condition.
|
||||
- HAVING is applied to the results of a query after
|
||||
aggregation (GROUP BY)
|
||||
|
||||
@@ -1409,8 +1411,7 @@ Result Cache API:
|
||||
|
||||
$query->setResultCacheDriver(new ApcCache());
|
||||
|
||||
$query->useResultCache(true)
|
||||
->setResultCacheLifeTime(3600);
|
||||
$query->enableResultCache(3600);
|
||||
|
||||
$result = $query->getResult(); // cache miss
|
||||
|
||||
@@ -1420,8 +1421,8 @@ Result Cache API:
|
||||
$query->setResultCacheId('my_query_result');
|
||||
$result = $query->getResult(); // saved in given result cache id.
|
||||
|
||||
// or call useResultCache() with all parameters:
|
||||
$query->useResultCache(true, 3600, 'my_query_result');
|
||||
// or call enableResultCache() with all parameters:
|
||||
$query->enableResultCache(3600, 'my_query_result');
|
||||
$result = $query->getResult(); // cache hit!
|
||||
|
||||
// Introspection
|
||||
@@ -1699,9 +1700,14 @@ From, Join and Index by
|
||||
SubselectIdentificationVariableDeclaration ::= IdentificationVariableDeclaration
|
||||
RangeVariableDeclaration ::= AbstractSchemaName ["AS"] AliasIdentificationVariable
|
||||
JoinAssociationDeclaration ::= JoinAssociationPathExpression ["AS"] AliasIdentificationVariable [IndexBy]
|
||||
Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN" (JoinAssociationDeclaration | RangeVariableDeclaration) ["WITH" ConditionalExpression]
|
||||
Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN" (JoinAssociationDeclaration ["WITH" ConditionalExpression] | RangeVariableDeclaration [("ON" | "WITH") ConditionalExpression])
|
||||
IndexBy ::= "INDEX" "BY" SingleValuedPathExpression
|
||||
|
||||
.. note::
|
||||
Using the ``WITH`` keyword for the ``ConditionalExpression`` of a
|
||||
``RangeVariableDeclaration`` is deprecated and will be removed in
|
||||
ORM 4.0. Use the ``ON`` keyword instead.
|
||||
|
||||
Select Expressions
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
@@ -18,30 +18,6 @@ In your mapping configuration, the column definition (for example, the
|
||||
the ``charset`` and ``collation``. The default values are ``utf8`` and
|
||||
``utf8_unicode_ci``, respectively.
|
||||
|
||||
Entity Classes
|
||||
--------------
|
||||
|
||||
How can I add default values to a column?
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Doctrine does not support to set the default values in columns through the "DEFAULT" keyword in SQL.
|
||||
This is not necessary however, you can just use your class properties as default values. These are then used
|
||||
upon insert:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
class User
|
||||
{
|
||||
private const STATUS_DISABLED = 0;
|
||||
private const STATUS_ENABLED = 1;
|
||||
|
||||
private string $algorithm = "sha1";
|
||||
/** @var self::STATUS_* */
|
||||
private int $status = self::STATUS_DISABLED;
|
||||
}
|
||||
|
||||
.
|
||||
|
||||
Mapping
|
||||
-------
|
||||
|
||||
|
||||
@@ -208,6 +208,22 @@ Example:
|
||||
// ...
|
||||
}
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<doctrine-mapping>
|
||||
<entity name="MyProject\Model\Person" inheritance-type="SINGLE_TABLE">
|
||||
<discriminator-column name="discr" type="string" />
|
||||
<discriminator-map>
|
||||
<discriminator-mapping value="person" class="MyProject\Model\Person"/>
|
||||
<discriminator-mapping value="employee" class="MyProject\Model\Employee"/>
|
||||
</discriminator-map>
|
||||
</entity>
|
||||
</doctrine-mapping>
|
||||
|
||||
<doctrine-mapping>
|
||||
<entity name="MyProject\Model\Employee">
|
||||
</entity>
|
||||
</doctrine-mapping>
|
||||
|
||||
In this example, the ``#[DiscriminatorMap]`` specifies that in the
|
||||
discriminator column, a value of "person" identifies a row as being of type
|
||||
|
||||
@@ -344,10 +344,10 @@ the Query object which can be retrieved from ``EntityManager#createQuery()``.
|
||||
Executing a Query
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
The QueryBuilder is a builder object only - it has no means of actually
|
||||
executing the Query. Additionally a set of parameters such as query hints
|
||||
cannot be set on the QueryBuilder itself. This is why you always have to convert
|
||||
a querybuilder instance into a Query object:
|
||||
The QueryBuilder is only a builder object - it has no means of actually
|
||||
executing the Query. Additional functionality, such as enabling the result cache,
|
||||
cannot be set on the QueryBuilder itself. This is why you must always convert
|
||||
a QueryBuilder instance into a Query object:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
@@ -355,9 +355,8 @@ a querybuilder instance into a Query object:
|
||||
// $qb instanceof QueryBuilder
|
||||
$query = $qb->getQuery();
|
||||
|
||||
// Set additional Query options
|
||||
$query->setQueryHint('foo', 'bar');
|
||||
$query->useResultCache('my_cache_id');
|
||||
// Enable the result cache
|
||||
$query->enableResultCache(3600, 'my_custom_id');
|
||||
|
||||
// Execute Query
|
||||
$result = $query->getResult();
|
||||
@@ -555,6 +554,24 @@ using ``addCriteria``:
|
||||
$qb->addCriteria($criteria);
|
||||
// then execute your query like normal
|
||||
|
||||
Adding hints to a Query
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You can also set query hints to a QueryBuilder by using ``setHint``:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
// ...
|
||||
|
||||
// $qb instanceof QueryBuilder
|
||||
$qb->setHint('hintName', 'hintValue');
|
||||
// then execute your query like normal
|
||||
|
||||
The query hint can hold anything the usual query hints can hold
|
||||
except null. Those hints will be applied to the query when the
|
||||
query is created.
|
||||
|
||||
Low Level API
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
|
||||
@@ -133,7 +133,7 @@ Caching mode
|
||||
* Read Write cache employs locks before update/delete.
|
||||
* Use if data needs to be updated.
|
||||
* Slowest strategy.
|
||||
* To use it a the cache region implementation must support locking.
|
||||
* To use it the cache region implementation must support locking.
|
||||
|
||||
|
||||
Built-in cached persisters
|
||||
|
||||
@@ -22,7 +22,7 @@ have to register them yourself.
|
||||
All the commands of the Doctrine Console require access to the
|
||||
``EntityManager``. You have to inject it into the console application.
|
||||
|
||||
Here is an example of a the project-specific ``bin/doctrine`` binary.
|
||||
Here is an example of a project-specific ``bin/doctrine`` binary.
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
@@ -96,6 +96,10 @@ The following Commands are currently available:
|
||||
- ``orm:schema-tool:update`` Processes the schema and either
|
||||
update the database schema of EntityManager Storage Connection or
|
||||
generate the SQL output.
|
||||
- ``orm:debug:event-manager`` Lists event listeners for an entity
|
||||
manager, optionally filtered by event name.
|
||||
- ``orm:debug:entity-listeners`` Lists entity listeners for a given
|
||||
entity, optionally filtered by event name.
|
||||
|
||||
The following alias is defined:
|
||||
|
||||
|
||||
@@ -1,6 +1,41 @@
|
||||
Pagination
|
||||
==========
|
||||
|
||||
Doctrine ORM provides two pagination strategies for DQL queries. Both handle
|
||||
the low-level SQL plumbing, but they make different trade-offs:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
||||
* - Feature
|
||||
- Offset ``Paginator``
|
||||
- ``CursorPaginator``
|
||||
* - Total count
|
||||
- Yes
|
||||
- No
|
||||
* - Random access to page N
|
||||
- Yes
|
||||
- No
|
||||
* - Stable under concurrent inserts/deletes
|
||||
- No
|
||||
- Yes
|
||||
* - Performance on deep pages
|
||||
- Degrades (OFFSET scan)
|
||||
- Constant (index range scan)
|
||||
* - Requires deterministic ORDER BY
|
||||
- No
|
||||
- Yes
|
||||
|
||||
Choose the **Offset Paginator** when you need a total page count or want to
|
||||
let users jump to an arbitrary page number.
|
||||
|
||||
Choose the **Cursor Paginator** when you need stable, high-performance
|
||||
pagination on large datasets and a simple previous/next navigation is
|
||||
sufficient.
|
||||
|
||||
Offset-Based Pagination
|
||||
-----------------------
|
||||
|
||||
Doctrine ORM ships with a Paginator for DQL queries. It
|
||||
has a very simple API and implements the SPL interfaces ``Countable`` and
|
||||
``IteratorAggregate``.
|
||||
@@ -58,3 +93,178 @@ In this way the `DISTINCT` keyword will be omitted and can bring important perfo
|
||||
->setHint(Paginator::HINT_ENABLE_DISTINCT, false)
|
||||
->setFirstResult(0)
|
||||
->setMaxResults(100);
|
||||
|
||||
Cursor-Based Pagination
|
||||
-----------------------
|
||||
|
||||
Doctrine ORM ships with a ``CursorPaginator`` for cursor-based pagination of DQL queries.
|
||||
Unlike offset-based pagination, cursor pagination uses opaque pointers (cursors) derived
|
||||
from the last seen row to fetch the next or previous page. This makes it stable and
|
||||
performant on large datasets — no matter how deep you paginate, the database always uses
|
||||
an index range scan instead of skipping rows.
|
||||
|
||||
.. note::
|
||||
|
||||
Cursor pagination requires a **deterministic ``ORDER BY`` clause**. Every column
|
||||
combination used for sorting must uniquely identify a position in the result set.
|
||||
A common pattern is to sort by a timestamp and then by primary key as a tie-breaker.
|
||||
|
||||
Basic Usage
|
||||
~~~~~~~~~~~
|
||||
|
||||
The ``$cursor`` parameter is an opaque string produced by a previous call to
|
||||
``getNextCursorAsString()`` or ``getPreviousCursorAsString()``. On the first request
|
||||
it is ``null`` or an empty string ``''`` — both are treated identically as the first
|
||||
page. It is typically read from the incoming HTTP query string:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
$cursor = $_GET['cursor'] ?? null; // null or '' on the first page
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
use Doctrine\ORM\Tools\CursorPagination\CursorPaginator;
|
||||
|
||||
$dql = 'SELECT p FROM BlogPost p ORDER BY p.createdAt DESC, p.id DESC';
|
||||
$query = $entityManager->createQuery($dql);
|
||||
|
||||
$paginator = (new CursorPaginator($query))
|
||||
->paginate(cursor: $cursor, limit: 15);
|
||||
|
||||
foreach ($paginator as $post) {
|
||||
echo $post->getTitle() . "\n";
|
||||
}
|
||||
|
||||
echo $paginator->getPreviousCursorAsString(); // previous encoded cursor string
|
||||
echo $paginator->getNextCursorAsString(); // next encoded cursor string
|
||||
|
||||
Navigating Pages
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Pass the encoded cursor back on subsequent requests to move forward or backward:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
// Next page
|
||||
$paginator->paginate(15, $nextCursor);
|
||||
|
||||
// Previous page
|
||||
$paginator->paginate(15, $previousCursor);
|
||||
|
||||
The cursor is an encoded string containing the location at which the next query should begin fetching results, along with the navigation direction.
|
||||
|
||||
API Reference
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
``CursorPaginator::paginate(?string $cursor, int $limit): self``
|
||||
Executes the query and stores the results. Fetches ``$limit + 1`` rows to
|
||||
detect whether a further page exists, then trims the extra row. Returns
|
||||
``$this`` for chaining.
|
||||
|
||||
``CursorPaginator::getNextCursor(): Cursor``
|
||||
Returns the ``Cursor`` object for the next page. Throws a ``LogicException``
|
||||
if there is no next page — call ``hasNextPage()`` first.
|
||||
|
||||
``CursorPaginator::getPreviousCursor(): Cursor``
|
||||
Returns the ``Cursor`` object for the previous page. Throws a ``LogicException``
|
||||
if there is no previous page — call ``hasPreviousPage()`` first.
|
||||
|
||||
``CursorPaginator::getNextCursorAsString(): string``
|
||||
Returns the encoded cursor to retrieve the next page. Throws a
|
||||
``LogicException`` if there is no next page — call ``hasNextPage()`` first.
|
||||
|
||||
``CursorPaginator::getPreviousCursorAsString(): string``
|
||||
Returns the encoded cursor to retrieve the previous page. Throws a
|
||||
``LogicException`` if there is no previous page — call ``hasPreviousPage()`` first.
|
||||
|
||||
``CursorPaginator::hasNextPage(): bool``
|
||||
Returns whether a next page is available.
|
||||
|
||||
``CursorPaginator::hasPreviousPage(): bool``
|
||||
Returns whether a previous page is available.
|
||||
|
||||
``CursorPaginator::hasToPaginate(): bool``
|
||||
Returns whether either a next or previous page exists (i.e. the result
|
||||
set spans more than one page).
|
||||
|
||||
``CursorPaginator::getValues(): array``
|
||||
Returns the raw entity array for the current page.
|
||||
|
||||
``CursorPaginator::getItems(): array``
|
||||
Returns an array of ``CursorItem`` objects, each wrapping an entity and its
|
||||
individual ``Cursor``. Useful when you need per-row cursors.
|
||||
|
||||
``CursorPaginator::getCursorForItem(mixed $item, bool $isNext = true): Cursor``
|
||||
Builds a ``Cursor`` pointing at a specific entity. ``$isNext = true`` means
|
||||
"start *after* this item"; ``false`` means "start *before* this item".
|
||||
|
||||
``CursorPaginator::count(): int``
|
||||
Returns the number of items on the current page (implements ``Countable``).
|
||||
|
||||
**Next page**
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
SELECT ...
|
||||
FROM post p
|
||||
WHERE (p.created_at < :cursor_val_0)
|
||||
OR (p.created_at = :cursor_val_0 AND p.id < :cursor_id_1)
|
||||
ORDER BY p.created_at DESC, p.id DESC
|
||||
LIMIT 16 -- limit + 1
|
||||
|
||||
**Previous page**
|
||||
|
||||
.. code-block:: sql
|
||||
|
||||
SELECT ...
|
||||
FROM post p
|
||||
WHERE (p.created_at > :cursor_val_0)
|
||||
OR (p.created_at = :cursor_val_0 AND p.id > :cursor_id_1)
|
||||
ORDER BY p.created_at ASC, p.id ASC -- reversed
|
||||
LIMIT 16
|
||||
|
||||
HTML Template Example
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The following example shows how to render a paginated list with previous/next
|
||||
navigation links using the ``CursorPaginator`` in a PHP template:
|
||||
|
||||
.. literalinclude:: pagination/cursor-pagination.php
|
||||
:language: php
|
||||
|
||||
Cursor Encoding
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
A cursor is serialized to a URL-safe string via ``Cursor::encodeToString()`` and
|
||||
deserialized back via the static ``Cursor::fromEncodedString()``. The format is a
|
||||
JSON object encoded with URL-safe Base64 (no padding):
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
{
|
||||
"p.createdAt": "2024-01-15T10:30:00+00:00",
|
||||
"p.id": 42,
|
||||
"_isNext": true
|
||||
}
|
||||
|
||||
The ``_isNext`` flag distinguishes next-page cursors from previous-page cursors.
|
||||
All other keys are the DQL path expressions (``alias.field``) of the ``ORDER BY``
|
||||
columns, and their values are the database representations of the pivot row's
|
||||
field values.
|
||||
|
||||
If you need a different serialization format (e.g. encryption), build it on top of
|
||||
a ``Cursor`` instance: call ``$cursor->toArray()`` to get the raw data, apply your
|
||||
own encoding, and reconstruct with ``new Cursor($parameters, $isNext)``.
|
||||
|
||||
Limitations
|
||||
~~~~~~~~~~~
|
||||
|
||||
- Every ``ORDER BY`` column must map to an entity field. Raw SQL expressions or
|
||||
computed columns in ``ORDER BY`` are not supported.
|
||||
- ``COUNT`` queries are not available; cursor pagination does not know the total
|
||||
number of results by design. If you need a total count, use the
|
||||
offset-based ``Paginator`` described above.
|
||||
- The query must have at least one ``ORDER BY`` item; the paginator throws a
|
||||
``LogicException`` otherwise.
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
use Doctrine\ORM\Tools\CursorPagination\CursorPaginator;
|
||||
|
||||
$cursor = $_GET['cursor'] ?? null;
|
||||
|
||||
$query = $entityManager->createQuery('SELECT p FROM BlogPost p ORDER BY p.createdAt DESC, p.id DESC');
|
||||
|
||||
/** @var CursorPaginator<BlogPost> $paginator */
|
||||
$paginator = (new CursorPaginator($query))
|
||||
->paginate(cursor: $cursor, limit: 15);
|
||||
?>
|
||||
<p><?= $paginator->count() ?> result(s) on this page.</p>
|
||||
|
||||
<ul>
|
||||
<?php foreach ($paginator as $post): ?>
|
||||
<li><?= escape($post->getTitle()) ?></li>
|
||||
<?php endforeach ?>
|
||||
</ul>
|
||||
|
||||
<?php if ($paginator->hasToPaginate()): ?>
|
||||
<nav>
|
||||
<?php if ($paginator->hasPreviousPage()): ?>
|
||||
<a href="?cursor=<?= escape($paginator->getPreviousCursorAsString()) ?>">Previous</a>
|
||||
<?php endif ?>
|
||||
|
||||
<?php if ($paginator->hasNextPage()): ?>
|
||||
<a href="?cursor=<?= escape($paginator->getNextCursorAsString()) ?>">Next</a>
|
||||
<?php endif ?>
|
||||
</nav>
|
||||
<?php endif ?>
|
||||
+13
-3
@@ -155,10 +155,20 @@
|
||||
</xs:restriction>
|
||||
</xs:simpleType>
|
||||
|
||||
<xs:complexType name="object">
|
||||
<xs:attribute name="class" type="xs:string" use="required"/>
|
||||
<xs:anyAttribute namespace="##other"/>
|
||||
</xs:complexType>
|
||||
|
||||
<xs:complexType name="option" mixed="true">
|
||||
<xs:choice minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:element name="option" type="orm:option"/>
|
||||
<xs:any minOccurs="0" maxOccurs="unbounded" namespace="##other"/>
|
||||
<xs:choice minOccurs="0" maxOccurs="1">
|
||||
<xs:element name="object" type="orm:object"/>
|
||||
<xs:sequence>
|
||||
<xs:choice minOccurs="0" maxOccurs="unbounded">
|
||||
<xs:element name="option" type="orm:option"/>
|
||||
<xs:any minOccurs="0" maxOccurs="unbounded" namespace="##other"/>
|
||||
</xs:choice>
|
||||
</xs:sequence>
|
||||
</xs:choice>
|
||||
<xs:attribute name="name" type="xs:NMTOKEN" use="required"/>
|
||||
<xs:anyAttribute namespace="##other"/>
|
||||
|
||||
@@ -52,6 +52,8 @@
|
||||
<rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
|
||||
<exclude-pattern>src/Mapping/Driver/LoadMappingFileImplementation.php</exclude-pattern>
|
||||
<exclude-pattern>src/Mapping/GetReflectionClassImplementation.php</exclude-pattern>
|
||||
<exclude-pattern>src/Persisters/SqlValueVisitorImplementation.php</exclude-pattern>
|
||||
<exclude-pattern>src/PersistentCollectionImplementation.php</exclude-pattern>
|
||||
<exclude-pattern>tests/*</exclude-pattern>
|
||||
</rule>
|
||||
|
||||
|
||||
+31
-55
@@ -619,7 +619,7 @@ parameters:
|
||||
path: src/EntityRepository.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\EntityRepository\:\:matching\(\) should return Doctrine\\Common\\Collections\\AbstractLazyCollection\<int, T of object\>&Doctrine\\Common\\Collections\\Selectable\<int, T of object\> but returns Doctrine\\ORM\\LazyCriteriaCollection\<\(int\|string\), object\>\.$#'
|
||||
message: '#^Method Doctrine\\ORM\\EntityRepository\:\:matching\(\) should return Doctrine\\Common\\Collections\\AbstractLazyCollection\<int, T of object\> but returns Doctrine\\ORM\\LazyCriteriaCollection\<\(int\|string\), object\>\.$#'
|
||||
identifier: return.type
|
||||
count: 1
|
||||
path: src/EntityRepository.php
|
||||
@@ -696,12 +696,6 @@ parameters:
|
||||
count: 1
|
||||
path: src/Internal/Hydration/AbstractHydrator.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Internal\\Hydration\\AbstractHydrator\:\:gatherRowData\(\) should return array\{data\: array\<array\>, newObjects\?\: array\<array\{class\: ReflectionClass, args\: array, obj\: object\}\>, scalars\?\: array\} but returns array\{data\: array, newObjects\: array\<array\{class\: ReflectionClass\<object\>, args\: array, obj\?\: object\}\>, scalars\?\: non\-empty\-array\}\.$#'
|
||||
identifier: return.type
|
||||
count: 1
|
||||
path: src/Internal/Hydration/AbstractHydrator.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Internal\\Hydration\\AbstractHydrator\:\:getClassMetadata\(\) return type with generic class Doctrine\\ORM\\Mapping\\ClassMetadata does not specify its types\: T$#'
|
||||
identifier: missingType.generics
|
||||
@@ -822,6 +816,12 @@ parameters:
|
||||
count: 1
|
||||
path: src/Internal/HydrationCompleteHandler.php
|
||||
|
||||
-
|
||||
message: '#^Offset int\|null might not exist on array\<int, object\>\.$#'
|
||||
identifier: offsetAccess.notFound
|
||||
count: 1
|
||||
path: src/Internal/StronglyConnectedComponents.php
|
||||
|
||||
-
|
||||
message: '#^Property Doctrine\\ORM\\Internal\\StronglyConnectedComponents\:\:\$representingNodes \(array\<int, object\>\) does not accept array\<int\|string, object\>\.$#'
|
||||
identifier: assign.propertyType
|
||||
@@ -1410,12 +1410,6 @@ parameters:
|
||||
count: 2
|
||||
path: src/Mapping/Driver/DatabaseDriver.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#1 \$asset of static method Doctrine\\ORM\\Mapping\\Driver\\DatabaseDriver\:\:getAssetName\(\) expects Doctrine\\DBAL\\Schema\\AbstractAsset, Doctrine\\DBAL\\Schema\\Column\|false given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/Mapping/Driver/DatabaseDriver.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#2 \$columnName of method Doctrine\\ORM\\Mapping\\Driver\\DatabaseDriver\:\:getFieldNameForColumn\(\) expects string, string\|false given\.$#'
|
||||
identifier: argument.type
|
||||
@@ -1447,7 +1441,7 @@ parameters:
|
||||
path: src/Mapping/Driver/XmlDriver.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#1 \$columnDef of method Doctrine\\ORM\\Mapping\\ClassMetadata\<T of object\>\:\:setDiscriminatorColumn\(\) expects array\{name\: string\|null, fieldName\?\: string\|null, type\?\: string\|null, length\?\: int\|null, columnDefinition\?\: string\|null, enumType\?\: class\-string\<BackedEnum\>\|null, options\?\: array\<string, mixed\>\|null\}\|Doctrine\\ORM\\Mapping\\DiscriminatorColumnMapping\|null, array\{name\: string\|null, type\: string, length\: int, columnDefinition\: string\|null, enumType\: string\|null, options\?\: array\<int\|string, array\<int\|string, mixed\>\|bool\|string\>\} given\.$#'
|
||||
message: '#^Parameter \#1 \$columnDef of method Doctrine\\ORM\\Mapping\\ClassMetadata\<T of object\>\:\:setDiscriminatorColumn\(\) expects array\{name\: string\|null, fieldName\?\: string\|null, type\?\: string\|null, length\?\: int\|null, columnDefinition\?\: string\|null, enumType\?\: class\-string\<BackedEnum\>\|null, options\?\: array\<string, mixed\>\|null\}\|Doctrine\\ORM\\Mapping\\DiscriminatorColumnMapping\|null, array\{name\: string\|null, type\: string, length\: int, columnDefinition\: string\|null, enumType\: string\|null, options\?\: array\<int\|string, array\<int\|string, mixed\>\|bool\|object\|string\>\} given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/Mapping/Driver/XmlDriver.php
|
||||
@@ -1477,7 +1471,7 @@ parameters:
|
||||
path: src/Mapping/Driver/XmlDriver.php
|
||||
|
||||
-
|
||||
message: '#^Property Doctrine\\ORM\\Mapping\\ClassMetadata\<T of object\>\:\:\$table \(array\{name\: string, schema\?\: string, indexes\?\: array, uniqueConstraints\?\: array, options\?\: array\<string, mixed\>, quoted\?\: bool\}\) does not accept array\{name\: string, schema\?\: string, indexes\?\: array, uniqueConstraints\?\: array, options\: array\<int\|string, array\<int\|string, mixed\>\|bool\|string\>, quoted\?\: bool\}\.$#'
|
||||
message: '#^Property Doctrine\\ORM\\Mapping\\ClassMetadata\<T of object\>\:\:\$table \(array\{name\: string, schema\?\: string, indexes\?\: array, uniqueConstraints\?\: array, options\?\: array\<string, mixed\>, quoted\?\: bool\}\) does not accept array\{name\: string, schema\?\: string, indexes\?\: array, uniqueConstraints\?\: array, options\: array\<int\|string, array\<int\|string, mixed\>\|bool\|object\|string\>, quoted\?\: bool\}\.$#'
|
||||
identifier: assign.propertyType
|
||||
count: 1
|
||||
path: src/Mapping/Driver/XmlDriver.php
|
||||
@@ -1536,6 +1530,12 @@ parameters:
|
||||
count: 1
|
||||
path: src/Mapping/LegacyReflectionFields.php
|
||||
|
||||
-
|
||||
message: '#^Strict comparison using \!\=\= between array\<string, string\> and null will always evaluate to true\.$#'
|
||||
identifier: notIdentical.alwaysTrue
|
||||
count: 1
|
||||
path: src/Mapping/ManyToManyOwningSideMapping.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Mapping\\MappedSuperclass\:\:__construct\(\) has parameter \$repositoryClass with generic class Doctrine\\ORM\\EntityRepository but does not specify its types\: T$#'
|
||||
identifier: missingType.generics
|
||||
@@ -1681,7 +1681,7 @@ parameters:
|
||||
path: src/PersistentCollection.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\PersistentCollection\:\:matching\(\) should return Doctrine\\Common\\Collections\\Collection\<TKey of \(int\|string\), T\> but returns Doctrine\\Common\\Collections\\ReadableCollection\<TKey of \(int\|string\), T\>&Doctrine\\Common\\Collections\\Selectable\<TKey of \(int\|string\), T\>\.$#'
|
||||
message: '#^Method Doctrine\\ORM\\PersistentCollection\:\:matching\(\) should return Doctrine\\Common\\Collections\\Collection\<TKey of \(int\|string\), T\> but returns Doctrine\\Common\\Collections\\ReadableCollection\<TKey of \(int\|string\), T\>\.$#'
|
||||
identifier: return.type
|
||||
count: 1
|
||||
path: src/PersistentCollection.php
|
||||
@@ -1693,7 +1693,7 @@ parameters:
|
||||
path: src/PersistentCollection.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#2 \$callback of function array_walk expects callable\(object, int\)\: mixed, array\{Doctrine\\Common\\Collections\\Collection\<TKey of \(int\|string\), T\>&Doctrine\\Common\\Collections\\Selectable\<TKey of \(int\|string\), T\>, ''add''\} given\.$#'
|
||||
message: '#^Parameter \#2 \$callback of function array_walk expects callable\(object, int\)\: mixed, array\{Doctrine\\Common\\Collections\\Collection\<TKey of \(int\|string\), T\>, ''add''\} given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/PersistentCollection.php
|
||||
@@ -1818,6 +1818,12 @@ parameters:
|
||||
count: 1
|
||||
path: src/Persisters/Collection/ManyToManyPersister.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Persisters\\Collection\\ManyToManyPersister\:\:count\(\) should return int\<0, max\> but returns int\.$#'
|
||||
identifier: return.type
|
||||
count: 1
|
||||
path: src/Persisters/Collection/ManyToManyPersister.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Persisters\\Collection\\ManyToManyPersister\:\:delete\(\) has parameter \$collection with generic class Doctrine\\ORM\\PersistentCollection but does not specify its types\: TKey, T$#'
|
||||
identifier: missingType.generics
|
||||
@@ -2557,7 +2563,7 @@ parameters:
|
||||
path: src/Query/Exec/MultiTableUpdateExecutor.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#3 \$types of method Doctrine\\DBAL\\Connection\:\:executeStatement\(\) expects array\<int\<0, max\>\|string, Doctrine\\DBAL\\ArrayParameterType\|Doctrine\\DBAL\\ParameterType\|Doctrine\\DBAL\\Types\\Type\|string\>, list\<Doctrine\\DBAL\\ArrayParameterType\|Doctrine\\DBAL\\ParameterType\|Doctrine\\DBAL\\Types\\Type\|int\|string\> given\.$#'
|
||||
message: '#^Parameter \#3 \$types of method Doctrine\\DBAL\\Connection\:\:executeStatement\(\) expects array\<int\<0, max\>\|string, Doctrine\\DBAL\\ArrayParameterType\|Doctrine\\DBAL\\ParameterType\|Doctrine\\DBAL\\Types\\Type\|string\>, list\<Doctrine\\DBAL\\ArrayParameterType\:\:ASCII\|Doctrine\\DBAL\\ArrayParameterType\:\:BINARY\|Doctrine\\DBAL\\ArrayParameterType\:\:INTEGER\|Doctrine\\DBAL\\ArrayParameterType\:\:STRING\|Doctrine\\DBAL\\ParameterType\:\:ASCII\|Doctrine\\DBAL\\ParameterType\:\:BINARY\|Doctrine\\DBAL\\ParameterType\:\:BOOLEAN\|Doctrine\\DBAL\\ParameterType\:\:INTEGER\|Doctrine\\DBAL\\ParameterType\:\:LARGE_OBJECT\|Doctrine\\DBAL\\ParameterType\:\:NULL\|Doctrine\\DBAL\\ParameterType\:\:STRING\|Doctrine\\DBAL\\Types\\Type\|int\|string\> given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/Query/Exec/MultiTableUpdateExecutor.php
|
||||
@@ -2580,36 +2586,12 @@ parameters:
|
||||
count: 1
|
||||
path: src/Query/Exec/SingleTableDeleteUpdateExecutor.php
|
||||
|
||||
-
|
||||
message: '#^PHPDoc type array\<string\> of property Doctrine\\ORM\\Query\\Expr\\Andx\:\:\$allowedClasses is not covariant with PHPDoc type list\<class\-string\> of overridden property Doctrine\\ORM\\Query\\Expr\\Base\:\:\$allowedClasses\.$#'
|
||||
identifier: property.phpDocType
|
||||
count: 1
|
||||
path: src/Query/Expr/Andx.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Query\\Expr\\Func\:\:getArguments\(\) should return list\<mixed\> but returns array\<mixed\>\.$#'
|
||||
identifier: return.type
|
||||
count: 1
|
||||
path: src/Query/Expr/Func.php
|
||||
|
||||
-
|
||||
message: '#^PHPDoc type array\<string\> of property Doctrine\\ORM\\Query\\Expr\\Orx\:\:\$allowedClasses is not covariant with PHPDoc type list\<class\-string\> of overridden property Doctrine\\ORM\\Query\\Expr\\Base\:\:\$allowedClasses\.$#'
|
||||
identifier: property.phpDocType
|
||||
count: 1
|
||||
path: src/Query/Expr/Orx.php
|
||||
|
||||
-
|
||||
message: '#^PHPDoc type array\<string\> of property Doctrine\\ORM\\Query\\Expr\\Select\:\:\$allowedClasses is not covariant with PHPDoc type list\<class\-string\> of overridden property Doctrine\\ORM\\Query\\Expr\\Base\:\:\$allowedClasses\.$#'
|
||||
identifier: property.phpDocType
|
||||
count: 1
|
||||
path: src/Query/Expr/Select.php
|
||||
|
||||
-
|
||||
message: '#^Property Doctrine\\ORM\\Query\\Filter\\SQLFilter\:\:\$parameters \(array\<string, array\{type\: string, value\: mixed, is_list\: bool\}\>\) does not accept non\-empty\-array\<string, array\{value\: mixed, type\: Doctrine\\DBAL\\ArrayParameterType\|Doctrine\\DBAL\\ParameterType\|int\|string, is_list\: bool\}\>\.$#'
|
||||
identifier: assign.propertyType
|
||||
count: 1
|
||||
path: src/Query/Filter/SQLFilter.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Query\\ParameterTypeInferer\:\:inferType\(\) never returns int so it can be removed from the return type\.$#'
|
||||
identifier: return.unusedType
|
||||
@@ -2880,12 +2862,6 @@ parameters:
|
||||
count: 1
|
||||
path: src/Tools/Console/Command/GenerateProxiesCommand.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#2 \$proxyDir of method Doctrine\\ORM\\Proxy\\ProxyFactory\:\:generateProxyClasses\(\) expects string\|null, string\|false given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/Tools/Console/Command/GenerateProxiesCommand.php
|
||||
|
||||
-
|
||||
message: '#^Method Doctrine\\ORM\\Tools\\Console\\Command\\MappingDescribeCommand\:\:getClassMetadata\(\) return type with generic class Doctrine\\ORM\\Mapping\\ClassMetadata does not specify its types\: T$#'
|
||||
identifier: missingType.generics
|
||||
@@ -3351,6 +3327,12 @@ parameters:
|
||||
count: 1
|
||||
path: src/UnitOfWork.php
|
||||
|
||||
-
|
||||
message: '#^Access to an undefined property Doctrine\\ORM\\Mapping\\AssociationMapping\:\:\$joinColumns\.$#'
|
||||
identifier: property.notFound
|
||||
count: 1
|
||||
path: src/UnitOfWork.php
|
||||
|
||||
-
|
||||
message: '#^Access to an undefined property Doctrine\\ORM\\Mapping\\ManyToManyInverseSideMapping\|Doctrine\\ORM\\Mapping\\ManyToManyOwningSideMapping\|Doctrine\\ORM\\Mapping\\ManyToOneAssociationMapping\|Doctrine\\ORM\\Mapping\\OneToManyAssociationMapping\|Doctrine\\ORM\\Mapping\\OneToOneInverseSideMapping\|Doctrine\\ORM\\Mapping\\OneToOneOwningSideMapping\:\:\$inversedBy\.$#'
|
||||
identifier: property.notFound
|
||||
@@ -3366,7 +3348,7 @@ parameters:
|
||||
-
|
||||
message: '#^Access to an undefined property Doctrine\\ORM\\Mapping\\ManyToManyInverseSideMapping\|Doctrine\\ORM\\Mapping\\ManyToManyOwningSideMapping\|Doctrine\\ORM\\Mapping\\ManyToOneAssociationMapping\|Doctrine\\ORM\\Mapping\\OneToManyAssociationMapping\|Doctrine\\ORM\\Mapping\\OneToOneInverseSideMapping\|Doctrine\\ORM\\Mapping\\OneToOneOwningSideMapping\:\:\$mappedBy\.$#'
|
||||
identifier: property.notFound
|
||||
count: 1
|
||||
count: 3
|
||||
path: src/UnitOfWork.php
|
||||
|
||||
-
|
||||
@@ -3453,12 +3435,6 @@ parameters:
|
||||
count: 2
|
||||
path: src/UnitOfWork.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#3 \$collection of class Doctrine\\ORM\\PersistentCollection constructor expects Doctrine\\Common\\Collections\\Collection\<\(int\|string\), mixed\>&Doctrine\\Common\\Collections\\Selectable\<\(int\|string\), mixed\>, Doctrine\\Common\\Collections\\Collection given\.$#'
|
||||
identifier: argument.type
|
||||
count: 1
|
||||
path: src/UnitOfWork.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#5 \$invoke of method Doctrine\\ORM\\Event\\ListenersInvoker\:\:invoke\(\) expects int\<0, 7\>, int\<min, \-1\>\|int\<1, max\> given\.$#'
|
||||
identifier: argument.type
|
||||
|
||||
@@ -4,6 +4,12 @@ includes:
|
||||
|
||||
parameters:
|
||||
reportUnmatchedIgnoredErrors: false # Some errors in the baseline only apply to DBAL 4
|
||||
excludePaths:
|
||||
# Compatibility shims for Collections 2 vs Collections 3
|
||||
# These have intentional signature mismatches that cannot be resolved
|
||||
- src/PersistentCollectionImplementation.php
|
||||
- src/Persisters/SqlValueVisitorImplementation.php
|
||||
|
||||
ignoreErrors:
|
||||
# Symfony cache supports passing a key prefix to the clear method.
|
||||
- '/^Method Psr\\Cache\\CacheItemPoolInterface\:\:clear\(\) invoked with 1 parameter, 0 required\.$/'
|
||||
@@ -98,6 +104,17 @@ parameters:
|
||||
identifier: argument.unresolvableType
|
||||
path: src/Mapping/Driver/DatabaseDriver.php
|
||||
|
||||
-
|
||||
message: '#^Parameter \#1 \$asset of static method Doctrine\\ORM\\Mapping\\Driver\\DatabaseDriver\:\:getAssetName\(\) expects Doctrine\\DBAL\\Schema\\AbstractAsset, Doctrine\\DBAL\\Schema\\Column\|false given\.$#'
|
||||
identifier: argument.type
|
||||
path: src/Mapping/Driver/DatabaseDriver.php
|
||||
|
||||
-
|
||||
message: '#^Instantiated class Doctrine\\DBAL\\Schema\\DefaultExpression\\\w+ not found\.$#'
|
||||
identifier: class.notFound
|
||||
path: src/Tools/SchemaTool.php
|
||||
|
||||
|
||||
# To be removed in 4.0
|
||||
-
|
||||
message: '#Negated boolean expression is always false\.#'
|
||||
@@ -149,3 +166,10 @@ parameters:
|
||||
-
|
||||
message: '~inferType.*never returns~'
|
||||
path: src/Query/ParameterTypeInferer.php
|
||||
|
||||
# Methods used by excluded compatibility shim traits
|
||||
-
|
||||
message: '#^Method .* is unused\.$#'
|
||||
paths:
|
||||
- src/PersistentCollection.php
|
||||
- src/Persisters/SqlValueVisitor.php
|
||||
|
||||
@@ -3,6 +3,12 @@ includes:
|
||||
- phpstan-params.neon
|
||||
|
||||
parameters:
|
||||
excludePaths:
|
||||
# Compatibility shims for Collections 2 vs Collections 3
|
||||
# These have intentional signature mismatches that cannot be resolved
|
||||
- src/PersistentCollectionImplementation.php
|
||||
- src/Persisters/SqlValueVisitorImplementation.php
|
||||
|
||||
ignoreErrors:
|
||||
# Symfony cache supports passing a key prefix to the clear method.
|
||||
- '/^Method Psr\\Cache\\CacheItemPoolInterface\:\:clear\(\) invoked with 1 parameter, 0 required\.$/'
|
||||
@@ -12,6 +18,10 @@ parameters:
|
||||
message: '~^Match expression does not handle remaining values:~'
|
||||
path: src/Utility/PersisterHelper.php
|
||||
|
||||
# The return type is already narrow enough.
|
||||
- '~^Method Doctrine\\ORM\\Query\\ParameterTypeInferer\:\:inferType\(\) never returns ''[a-z_]+'' so it can be removed from the return type\.$~'
|
||||
- '~^Method Doctrine\\ORM\\Query\\ParameterTypeInferer\:\:inferType\(\) never returns Doctrine\\DBAL\\(?:Array)?ParameterType\:\:[A-Z_]+ so it can be removed from the return type\.$~'
|
||||
|
||||
# DBAL 4 compatibility
|
||||
-
|
||||
message: '~^Method Doctrine\\ORM\\Query\\AST\\Functions\\TrimFunction::getTrimMode\(\) never returns .* so it can be removed from the return type\.$~'
|
||||
@@ -50,3 +60,10 @@ parameters:
|
||||
-
|
||||
message: '#Expression on left side of \?\? is not nullable.#'
|
||||
path: src/Mapping/Driver/AttributeDriver.php
|
||||
|
||||
# Methods used by excluded compatibility shim traits
|
||||
-
|
||||
message: '#^Method .* is unused\.$#'
|
||||
paths:
|
||||
- src/PersistentCollection.php
|
||||
- src/Persisters/SqlValueVisitor.php
|
||||
|
||||
@@ -1065,7 +1065,7 @@ abstract class AbstractQuery
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the query and returns a the resulting Statement object.
|
||||
* Executes the query and returns the resulting Statement object.
|
||||
*
|
||||
* @return Result|int The executed database statement that holds
|
||||
* the results, or an integer indicating how
|
||||
|
||||
@@ -5,7 +5,7 @@ declare(strict_types=1);
|
||||
namespace Doctrine\ORM\Decorator;
|
||||
|
||||
use DateTimeInterface;
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventManagerInterface;
|
||||
use Doctrine\DBAL\Connection;
|
||||
use Doctrine\DBAL\LockMode;
|
||||
use Doctrine\ORM\Cache;
|
||||
@@ -122,7 +122,7 @@ abstract class EntityManagerDecorator extends ObjectManagerDecorator implements
|
||||
$this->wrapped->refresh($object, $lockMode);
|
||||
}
|
||||
|
||||
public function getEventManager(): EventManager
|
||||
public function getEventManager(): EventManagerInterface
|
||||
{
|
||||
return $this->wrapped->getEventManager();
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ namespace Doctrine\ORM;
|
||||
use BackedEnum;
|
||||
use DateTimeInterface;
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventManagerInterface;
|
||||
use Doctrine\DBAL\Connection;
|
||||
use Doctrine\DBAL\LockMode;
|
||||
use Doctrine\ORM\Exception\EntityManagerClosed;
|
||||
@@ -511,7 +512,7 @@ class EntityManager implements EntityManagerInterface
|
||||
&& ! $this->unitOfWork->isScheduledForDelete($object);
|
||||
}
|
||||
|
||||
public function getEventManager(): EventManager
|
||||
public function getEventManager(): EventManagerInterface
|
||||
{
|
||||
return $this->eventManager;
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ declare(strict_types=1);
|
||||
namespace Doctrine\ORM;
|
||||
|
||||
use DateTimeInterface;
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventManagerInterface;
|
||||
use Doctrine\DBAL\Connection;
|
||||
use Doctrine\DBAL\LockMode;
|
||||
use Doctrine\ORM\Exception\ORMException;
|
||||
@@ -180,9 +180,9 @@ interface EntityManagerInterface extends ObjectManager
|
||||
public function lock(object $entity, LockMode|int $lockMode, DateTimeInterface|int|null $lockVersion = null): void;
|
||||
|
||||
/**
|
||||
* Gets the EventManager used by the EntityManager.
|
||||
* Gets the EventManagerInterface used by the EntityManager.
|
||||
*/
|
||||
public function getEventManager(): EventManager;
|
||||
public function getEventManager(): EventManagerInterface;
|
||||
|
||||
/**
|
||||
* Gets the Configuration used by the EntityManager.
|
||||
|
||||
@@ -5,7 +5,7 @@ declare(strict_types=1);
|
||||
namespace Doctrine\ORM\Event;
|
||||
|
||||
use Doctrine\Common\EventArgs;
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventDispatcher;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\EntityListenerResolver;
|
||||
@@ -23,13 +23,13 @@ class ListenersInvoker
|
||||
/** The Entity listener resolver. */
|
||||
private readonly EntityListenerResolver $resolver;
|
||||
|
||||
/** The EventManager used for dispatching events. */
|
||||
private readonly EventManager $eventManager;
|
||||
/** The EventDispatcher used for dispatching events. */
|
||||
private readonly EventDispatcher $eventDispatcher;
|
||||
|
||||
public function __construct(EntityManagerInterface $em)
|
||||
{
|
||||
$this->eventManager = $em->getEventManager();
|
||||
$this->resolver = $em->getConfiguration()->getEntityListenerResolver();
|
||||
$this->eventDispatcher = $em->getEventManager();
|
||||
$this->resolver = $em->getConfiguration()->getEntityListenerResolver();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -52,7 +52,7 @@ class ListenersInvoker
|
||||
$invoke |= self::INVOKE_LISTENERS;
|
||||
}
|
||||
|
||||
if ($this->eventManager->hasListeners($eventName)) {
|
||||
if ($this->eventDispatcher->hasListeners($eventName)) {
|
||||
$invoke |= self::INVOKE_MANAGER;
|
||||
}
|
||||
|
||||
@@ -92,7 +92,7 @@ class ListenersInvoker
|
||||
}
|
||||
|
||||
if ($invoke & self::INVOKE_MANAGER) {
|
||||
$this->eventManager->dispatchEvent($eventName, $event);
|
||||
$this->eventDispatcher->dispatchEvent($eventName, $event);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -17,6 +17,7 @@ use Doctrine\ORM\UnitOfWork;
|
||||
use Generator;
|
||||
use LogicException;
|
||||
use ReflectionClass;
|
||||
use ReflectionEnum;
|
||||
|
||||
use function array_key_exists;
|
||||
use function array_keys;
|
||||
@@ -597,13 +598,18 @@ abstract class AbstractHydrator
|
||||
*/
|
||||
final protected function buildEnum(mixed $value, string $enumType): BackedEnum|array
|
||||
{
|
||||
$reflection = new ReflectionEnum($enumType);
|
||||
$isIntBacked = $reflection->isBacked() && $reflection->getBackingType()->getName() === 'int';
|
||||
|
||||
if (is_array($value)) {
|
||||
return array_map(
|
||||
static fn ($value) => $enumType::from($value),
|
||||
static fn ($value) => $enumType::from($isIntBacked ? (int) $value : $value),
|
||||
$value,
|
||||
);
|
||||
}
|
||||
|
||||
$value = $isIntBacked ? (int) $value : $value;
|
||||
|
||||
return $enumType::from($value);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,7 +7,6 @@ namespace Doctrine\ORM\Internal\Hydration;
|
||||
use Doctrine\DBAL\Driver\Exception;
|
||||
use Doctrine\ORM\Exception\MultipleSelectorsFoundException;
|
||||
|
||||
use function array_column;
|
||||
use function count;
|
||||
|
||||
/**
|
||||
@@ -27,8 +26,6 @@ final class ScalarColumnHydrator extends AbstractHydrator
|
||||
throw MultipleSelectorsFoundException::create($this->resultSetMapping()->fieldMappings);
|
||||
}
|
||||
|
||||
$result = $this->statement()->fetchAllNumeric();
|
||||
|
||||
return array_column($result, 0);
|
||||
return $this->statement()->fetchFirstColumn();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,8 +11,6 @@ use Doctrine\Common\Collections\ReadableCollection;
|
||||
use Doctrine\Common\Collections\Selectable;
|
||||
use Doctrine\ORM\Persisters\Entity\EntityPersister;
|
||||
|
||||
use function assert;
|
||||
|
||||
/**
|
||||
* A lazy collection that allows a fast count when using criteria object
|
||||
* Once count gets executed once without collection being initialized, result
|
||||
@@ -26,6 +24,7 @@ use function assert;
|
||||
*/
|
||||
class LazyCriteriaCollection extends AbstractLazyCollection implements Selectable
|
||||
{
|
||||
/** @var non-negative-int|null */
|
||||
private int|null $count = null;
|
||||
|
||||
public function __construct(
|
||||
@@ -83,7 +82,6 @@ class LazyCriteriaCollection extends AbstractLazyCollection implements Selectabl
|
||||
public function matching(Criteria $criteria): ReadableCollection&Selectable
|
||||
{
|
||||
$this->initialize();
|
||||
assert($this->collection instanceof Selectable);
|
||||
|
||||
return $this->collection->matching($criteria);
|
||||
}
|
||||
|
||||
@@ -113,6 +113,10 @@ class AssociationBuilder
|
||||
string|null $onDelete = null,
|
||||
string|null $columnDef = null,
|
||||
): static {
|
||||
if ($this->mapping['id'] ?? false) {
|
||||
$nullable = null;
|
||||
}
|
||||
|
||||
$this->joinColumns[] = [
|
||||
'name' => $columnName,
|
||||
'referencedColumnName' => $referencedColumnName,
|
||||
@@ -133,6 +137,9 @@ class AssociationBuilder
|
||||
public function makePrimaryKey(): static
|
||||
{
|
||||
$this->mapping['id'] = true;
|
||||
foreach ($this->joinColumns ?? [] as $i => $joinColumn) {
|
||||
$this->joinColumns[$i]['nullable'] = null;
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
@@ -24,6 +24,30 @@ class ManyToManyAssociationBuilder extends OneToManyAssociationBuilder
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add Join Columns.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function addJoinColumn(
|
||||
string $columnName,
|
||||
string $referencedColumnName,
|
||||
bool $nullable = true,
|
||||
bool $unique = false,
|
||||
string|null $onDelete = null,
|
||||
string|null $columnDef = null,
|
||||
): static {
|
||||
$this->joinColumns[] = [
|
||||
'name' => $columnName,
|
||||
'referencedColumnName' => $referencedColumnName,
|
||||
'unique' => $unique,
|
||||
'onDelete' => $onDelete,
|
||||
'columnDefinition' => $columnDef,
|
||||
];
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds Inverse Join Columns.
|
||||
*
|
||||
@@ -40,7 +64,6 @@ class ManyToManyAssociationBuilder extends OneToManyAssociationBuilder
|
||||
$this->inverseJoinColumns[] = [
|
||||
'name' => $columnName,
|
||||
'referencedColumnName' => $referencedColumnName,
|
||||
'nullable' => $nullable,
|
||||
'unique' => $unique,
|
||||
'onDelete' => $onDelete,
|
||||
'columnDefinition' => $columnDef,
|
||||
|
||||
@@ -546,7 +546,7 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
*/
|
||||
public LegacyReflectionFields|array $reflFields = [];
|
||||
|
||||
/** @var array<string, PropertyAccessors\PropertyAccessor> */
|
||||
/** @var array<string, PropertyAccessor> */
|
||||
public array $propertyAccessors = [];
|
||||
|
||||
private InstantiatorInterface|null $instantiator = null;
|
||||
@@ -584,7 +584,7 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
/**
|
||||
* Gets the ReflectionProperties of the mapped class.
|
||||
*
|
||||
* @return PropertyAccessor[] An array of PropertyAccessor instances.
|
||||
* @return array<string, PropertyAccessor> An array of PropertyAccessor instances by name.
|
||||
*/
|
||||
public function getPropertyAccessors(): array
|
||||
{
|
||||
@@ -2204,6 +2204,20 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
throw MappingException::invalidDiscriminatorColumnType($this->name, $columnDef['type']);
|
||||
}
|
||||
|
||||
if (isset($columnDef['enumType'])) {
|
||||
if (! enum_exists($columnDef['enumType'])) {
|
||||
throw MappingException::nonEnumTypeMapped($this->name, $columnDef['fieldName'], $columnDef['enumType']);
|
||||
}
|
||||
|
||||
if (
|
||||
defined('Doctrine\DBAL\Types\Types::ENUM')
|
||||
&& $columnDef['type'] === Types::ENUM
|
||||
&& ! isset($columnDef['options']['values'])
|
||||
) {
|
||||
$columnDef['options']['values'] = array_column($columnDef['enumType']::cases(), 'value');
|
||||
}
|
||||
}
|
||||
|
||||
$this->discriminatorColumn = DiscriminatorColumnMapping::fromMappingArray($columnDef);
|
||||
}
|
||||
}
|
||||
@@ -2222,6 +2236,8 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
* Used for JOINED and SINGLE_TABLE inheritance mapping strategies.
|
||||
*
|
||||
* @param array<int|string, string> $map
|
||||
*
|
||||
* @throws MappingException
|
||||
*/
|
||||
public function setDiscriminatorMap(array $map): void
|
||||
{
|
||||
@@ -2241,6 +2257,16 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
);
|
||||
}
|
||||
|
||||
$values = $this->discriminatorColumn->options['values'] ?? null;
|
||||
|
||||
if ($values !== null) {
|
||||
$diff = array_diff(array_keys($map), $values);
|
||||
|
||||
if ($diff !== []) {
|
||||
throw MappingException::invalidEntriesInDiscriminatorMap(array_values($diff), $this->name, $this->discriminatorColumn->enumType);
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($map as $value => $className) {
|
||||
$this->addDiscriminatorMapClass($value, $className);
|
||||
}
|
||||
@@ -2454,9 +2480,9 @@ class ClassMetadata implements PersistenceClassMetadata, Stringable
|
||||
|
||||
if (! isset($mapping['default'])) {
|
||||
if (in_array($mapping['type'], ['integer', 'bigint', 'smallint'], true)) {
|
||||
$mapping['default'] = 1;
|
||||
$mapping['options']['default'] = 1;
|
||||
} elseif ($mapping['type'] === 'datetime') {
|
||||
$mapping['default'] = 'CURRENT_TIMESTAMP';
|
||||
$mapping['options']['default'] = 'CURRENT_TIMESTAMP';
|
||||
} else {
|
||||
throw MappingException::unsupportedOptimisticLockingType($this->name, $mapping['fieldName'], $mapping['type']);
|
||||
}
|
||||
|
||||
@@ -4,7 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Mapping;
|
||||
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventDispatcher;
|
||||
use Doctrine\DBAL\Platforms;
|
||||
use Doctrine\DBAL\Platforms\AbstractPlatform;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
@@ -55,7 +55,7 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory
|
||||
private EntityManagerInterface|null $em = null;
|
||||
private AbstractPlatform|null $targetPlatform = null;
|
||||
private MappingDriver|null $driver = null;
|
||||
private EventManager|null $evm = null;
|
||||
private EventDispatcher|null $eventDispatcher = null;
|
||||
|
||||
/** @var mixed[] */
|
||||
private array $embeddablesActiveNesting = [];
|
||||
@@ -109,20 +109,16 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory
|
||||
|
||||
protected function initialize(): void
|
||||
{
|
||||
$this->driver = $this->em->getConfiguration()->getMetadataDriverImpl();
|
||||
$this->evm = $this->em->getEventManager();
|
||||
$this->initialized = true;
|
||||
$this->driver = $this->em->getConfiguration()->getMetadataDriverImpl();
|
||||
$this->eventDispatcher = $this->em->getEventManager();
|
||||
$this->initialized = true;
|
||||
}
|
||||
|
||||
protected function onNotFoundMetadata(string $className): ClassMetadata|null
|
||||
{
|
||||
if (! $this->evm->hasListeners(Events::onClassMetadataNotFound)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$eventArgs = new OnClassMetadataNotFoundEventArgs($className, $this->em);
|
||||
|
||||
$this->evm->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
|
||||
$this->eventDispatcher->dispatchEvent(Events::onClassMetadataNotFound, $eventArgs);
|
||||
$classMetadata = $eventArgs->getFoundMetadata();
|
||||
assert($classMetadata instanceof ClassMetadata || $classMetadata === null);
|
||||
|
||||
@@ -245,10 +241,10 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory
|
||||
// During the following event, there may also be updates to the discriminator map as per GH-1257/GH-8402.
|
||||
// So, we must not discover the missing subclasses before that.
|
||||
|
||||
if ($this->evm->hasListeners(Events::loadClassMetadata)) {
|
||||
$eventArgs = new LoadClassMetadataEventArgs($class, $this->em);
|
||||
$this->evm->dispatchEvent(Events::loadClassMetadata, $eventArgs);
|
||||
}
|
||||
$this->eventDispatcher->dispatchEvent(
|
||||
Events::loadClassMetadata,
|
||||
new LoadClassMetadataEventArgs($class, $this->em),
|
||||
);
|
||||
|
||||
$this->findAbstractEntityClassesNotListedInDiscriminatorMap($class);
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ use Doctrine\ORM\Mapping\Builder\EntityListenerBuilder;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\MappingException;
|
||||
use Doctrine\Persistence\Mapping\ClassMetadata as PersistenceClassMetadata;
|
||||
use Doctrine\Persistence\Mapping\Driver\ClassLocator;
|
||||
use Doctrine\Persistence\Mapping\Driver\ColocatedMappingDriver;
|
||||
use Doctrine\Persistence\Mapping\Driver\MappingDriver;
|
||||
use InvalidArgumentException;
|
||||
@@ -35,10 +36,10 @@ class AttributeDriver implements MappingDriver
|
||||
private readonly AttributeReader $reader;
|
||||
|
||||
/**
|
||||
* @param array<string> $paths
|
||||
* @param true $reportFieldsWhereDeclared no-op, to be removed in 4.0
|
||||
* @param string[]|ClassLocator $paths a ClassLocator, or an array of directories.
|
||||
* @param true $reportFieldsWhereDeclared no-op, to be removed in 4.0
|
||||
*/
|
||||
public function __construct(array $paths, bool $reportFieldsWhereDeclared = true)
|
||||
public function __construct(array|ClassLocator $paths, bool $reportFieldsWhereDeclared = true)
|
||||
{
|
||||
if (! $reportFieldsWhereDeclared) {
|
||||
throw new InvalidArgumentException(sprintf(
|
||||
@@ -48,7 +49,12 @@ class AttributeDriver implements MappingDriver
|
||||
}
|
||||
|
||||
$this->reader = new AttributeReader();
|
||||
$this->addPaths($paths);
|
||||
|
||||
if ($paths instanceof ClassLocator) {
|
||||
$this->classLocator = $paths;
|
||||
} else {
|
||||
$this->addPaths($paths);
|
||||
}
|
||||
}
|
||||
|
||||
public function isTransient(string $className): bool
|
||||
|
||||
@@ -4,8 +4,6 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Mapping\Driver;
|
||||
|
||||
use Doctrine\Common\Collections\Criteria;
|
||||
use Doctrine\Common\Collections\Order;
|
||||
use Doctrine\ORM\Mapping\Builder\EntityListenerBuilder;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\MappingException;
|
||||
@@ -18,10 +16,10 @@ use LogicException;
|
||||
use SimpleXMLElement;
|
||||
|
||||
use function assert;
|
||||
use function class_exists;
|
||||
use function constant;
|
||||
use function count;
|
||||
use function defined;
|
||||
use function enum_exists;
|
||||
use function explode;
|
||||
use function extension_loaded;
|
||||
use function file_get_contents;
|
||||
@@ -409,10 +407,7 @@ class XmlDriver extends FileDriver
|
||||
if (isset($oneToManyElement->{'order-by'})) {
|
||||
$orderBy = [];
|
||||
foreach ($oneToManyElement->{'order-by'}->{'order-by-field'} ?? [] as $orderByField) {
|
||||
$orderBy[(string) $orderByField['name']] = isset($orderByField['direction'])
|
||||
? (string) $orderByField['direction']
|
||||
// @phpstan-ignore classConstant.deprecated
|
||||
: (enum_exists(Order::class) ? Order::Ascending->value : Criteria::ASC);
|
||||
$orderBy[(string) $orderByField['name']] = (string) ($orderByField['direction'] ?? 'ASC');
|
||||
}
|
||||
|
||||
$mapping['orderBy'] = $orderBy;
|
||||
@@ -538,10 +533,7 @@ class XmlDriver extends FileDriver
|
||||
if (isset($manyToManyElement->{'order-by'})) {
|
||||
$orderBy = [];
|
||||
foreach ($manyToManyElement->{'order-by'}->{'order-by-field'} ?? [] as $orderByField) {
|
||||
$orderBy[(string) $orderByField['name']] = isset($orderByField['direction'])
|
||||
? (string) $orderByField['direction']
|
||||
// @phpstan-ignore classConstant.deprecated
|
||||
: (enum_exists(Order::class) ? Order::Ascending->value : Criteria::ASC);
|
||||
$orderBy[(string) $orderByField['name']] = (string) ($orderByField['direction'] ?? 'ASC');
|
||||
}
|
||||
|
||||
$mapping['orderBy'] = $orderBy;
|
||||
@@ -665,15 +657,30 @@ class XmlDriver extends FileDriver
|
||||
* Parses (nested) option elements.
|
||||
*
|
||||
* @return mixed[] The options array.
|
||||
* @phpstan-return array<int|string, array<int|string, mixed|string>|bool|string>
|
||||
* @phpstan-return array<int|string, array<int|string, mixed|string>|bool|string|object>
|
||||
*/
|
||||
private function parseOptions(SimpleXMLElement|null $options): array
|
||||
{
|
||||
$array = [];
|
||||
|
||||
foreach ($options ?? [] as $option) {
|
||||
$value = null;
|
||||
if ($option->count()) {
|
||||
$value = $this->parseOptions($option->children());
|
||||
// Check if this option contains an <object> element
|
||||
$children = $option->children();
|
||||
$hasObjectElement = false;
|
||||
|
||||
foreach ($children as $child) {
|
||||
if ($child->getName() === 'object') {
|
||||
$value = $this->parseObjectElement($child);
|
||||
$hasObjectElement = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (! $hasObjectElement) {
|
||||
$value = $this->parseOptions($children);
|
||||
}
|
||||
} else {
|
||||
$value = (string) $option;
|
||||
}
|
||||
@@ -693,6 +700,33 @@ class XmlDriver extends FileDriver
|
||||
return $array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses an <object> element and returns the instantiated object.
|
||||
*
|
||||
* @param SimpleXMLElement $objectElement The XML element.
|
||||
*
|
||||
* @return object The instantiated object.
|
||||
*
|
||||
* @throws MappingException If the object specification is invalid.
|
||||
* @throws InvalidArgumentException If the class does not exist.
|
||||
*/
|
||||
private function parseObjectElement(SimpleXMLElement $objectElement): object
|
||||
{
|
||||
$attributes = $objectElement->attributes();
|
||||
|
||||
if (! isset($attributes->class)) {
|
||||
throw MappingException::missingRequiredOption('object', 'class');
|
||||
}
|
||||
|
||||
$className = (string) $attributes->class;
|
||||
|
||||
if (! class_exists($className)) {
|
||||
throw new InvalidArgumentException(sprintf('Class "%s" does not exist', $className));
|
||||
}
|
||||
|
||||
return new $className();
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a joinColumn mapping array based on the information
|
||||
* found in the given SimpleXMLElement.
|
||||
|
||||
@@ -71,7 +71,9 @@ final class FieldMapping implements ArrayAccess
|
||||
public string|null $declaredField = null;
|
||||
public array|null $options = null;
|
||||
public bool|null $version = null;
|
||||
public string|int|null $default = null;
|
||||
|
||||
/** @deprecated Use options with 'default' key instead */
|
||||
public string|int|null $default = null;
|
||||
|
||||
/**
|
||||
* @param string $type The type name of the mapped field. Can be one of
|
||||
@@ -140,7 +142,7 @@ final class FieldMapping implements ArrayAccess
|
||||
{
|
||||
$serialized = ['type', 'fieldName', 'columnName'];
|
||||
|
||||
foreach (['nullable', 'notInsertable', 'notUpdatable', 'id', 'unique', 'version', 'quoted'] as $boolKey) {
|
||||
foreach (['nullable', 'notInsertable', 'notUpdatable', 'id', 'unique', 'version', 'quoted', 'index'] as $boolKey) {
|
||||
if ($this->$boolKey) {
|
||||
$serialized[] = $boolKey;
|
||||
}
|
||||
|
||||
@@ -84,9 +84,14 @@ final class JoinTableMapping implements ArrayAccess
|
||||
/** @return mixed[] */
|
||||
public function toArray(): array
|
||||
{
|
||||
$array = (array) $this;
|
||||
$array = (array) $this;
|
||||
$toArray = static function (JoinColumnMapping $column) {
|
||||
$array = (array) $column;
|
||||
|
||||
$toArray = static fn (JoinColumnMapping $column): array => (array) $column;
|
||||
unset($array['nullable']);
|
||||
|
||||
return $array;
|
||||
};
|
||||
$array['joinColumns'] = array_map($toArray, $array['joinColumns']);
|
||||
$array['inverseJoinColumns'] = array_map($toArray, $array['inverseJoinColumns']);
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Mapping;
|
||||
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
|
||||
use function strtolower;
|
||||
use function trim;
|
||||
|
||||
@@ -127,6 +129,20 @@ final class ManyToManyOwningSideMapping extends ToManyOwningSideMapping implemen
|
||||
$mapping->joinTableColumns = [];
|
||||
|
||||
foreach ($mapping->joinTable->joinColumns as $joinColumn) {
|
||||
if ($joinColumn->nullable !== null) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/12126',
|
||||
<<<'DEPRECATION'
|
||||
Specifying the "nullable" attribute for join columns in many-to-many associations (here, %s::$%s) is a no-op.
|
||||
The ORM will always set it to false.
|
||||
Doing so is deprecated and will be an error in 4.0.
|
||||
DEPRECATION,
|
||||
$mapping->sourceEntity,
|
||||
$mapping->fieldName,
|
||||
);
|
||||
}
|
||||
|
||||
$joinColumn->nullable = false;
|
||||
|
||||
if (empty($joinColumn->referencedColumnName)) {
|
||||
@@ -152,6 +168,20 @@ final class ManyToManyOwningSideMapping extends ToManyOwningSideMapping implemen
|
||||
}
|
||||
|
||||
foreach ($mapping->joinTable->inverseJoinColumns as $inverseJoinColumn) {
|
||||
if ($inverseJoinColumn->nullable !== null) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/12126',
|
||||
<<<'DEPRECATION'
|
||||
Specifying the "nullable" attribute for join columns in many-to-many associations (here, %s::$%s) is a no-op.
|
||||
The ORM will always set it to false.
|
||||
Doing so is deprecated and will be an error in 4.0.
|
||||
DEPRECATION,
|
||||
$mapping->targetEntity,
|
||||
$mapping->fieldName,
|
||||
);
|
||||
}
|
||||
|
||||
$inverseJoinColumn->nullable = false;
|
||||
|
||||
if (empty($inverseJoinColumn->referencedColumnName)) {
|
||||
|
||||
@@ -179,7 +179,7 @@ class MappingException extends PersistenceMappingException implements ORMExcepti
|
||||
|
||||
public static function joinTableRequired(string $fieldName): self
|
||||
{
|
||||
return new self(sprintf("The mapping of field '%s' requires an the 'joinTable' attribute.", $fieldName));
|
||||
return new self(sprintf("The mapping of field '%s' requires the 'joinTable' attribute.", $fieldName));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -329,6 +329,24 @@ class MappingException extends PersistenceMappingException implements ORMExcepti
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an exception that indicates that discriminator entries used in a discriminator map
|
||||
* does not exist in the backed enum provided by enumType option.
|
||||
*
|
||||
* @param array<int,int|string> $entries The discriminator entries that could not be found.
|
||||
* @param string $owningClass The class that declares the discriminator map.
|
||||
* @param string $enumType The enum that entries were checked against.
|
||||
*/
|
||||
public static function invalidEntriesInDiscriminatorMap(array $entries, string $owningClass, string $enumType): self
|
||||
{
|
||||
return new self(sprintf(
|
||||
"The entries %s in the discriminator map of class '%s' do not correspond to enum cases of '%s'.",
|
||||
implode(', ', array_map(static fn ($entry): string => sprintf("'%s'", $entry), $entries)),
|
||||
$owningClass,
|
||||
$enumType,
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an exception that indicates that a class used in a discriminator map does not exist.
|
||||
* An example would be an outdated (maybe renamed) classname.
|
||||
|
||||
@@ -10,6 +10,8 @@ use ReflectionProperty;
|
||||
|
||||
use function sprintf;
|
||||
|
||||
use const PHP_VERSION_ID;
|
||||
|
||||
/** @internal */
|
||||
class ReadonlyAccessor implements PropertyAccessor
|
||||
{
|
||||
@@ -26,7 +28,12 @@ class ReadonlyAccessor implements PropertyAccessor
|
||||
|
||||
public function setValue(object $object, mixed $value): void
|
||||
{
|
||||
if (! $this->reflectionProperty->isInitialized($object)) {
|
||||
/* For lazy properties, skip the isInitialized() check
|
||||
because it would trigger the initialization of the whole object. */
|
||||
if (
|
||||
PHP_VERSION_ID >= 80400 && $this->reflectionProperty->isLazy($object)
|
||||
|| ! $this->reflectionProperty->isInitialized($object)
|
||||
) {
|
||||
$this->parent->setValue($object, $value);
|
||||
|
||||
return;
|
||||
|
||||
@@ -4,6 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Mapping;
|
||||
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use RuntimeException;
|
||||
|
||||
use function array_flip;
|
||||
@@ -131,6 +132,20 @@ abstract class ToOneOwningSideMapping extends OwningSideMapping implements ToOne
|
||||
|
||||
foreach ($mapping->joinColumns as $joinColumn) {
|
||||
if ($mapping->id) {
|
||||
if ($joinColumn->nullable !== null) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/12126',
|
||||
<<<'DEPRECATION'
|
||||
Specifying the "nullable" attribute for join columns in to-one associations (here, %s::$%s) that are part of the identifier is a no-op.
|
||||
The ORM will always set it to false.
|
||||
Doing so is deprecated and will be an error in 4.0.
|
||||
DEPRECATION,
|
||||
$mapping->sourceEntity,
|
||||
$mapping->fieldName,
|
||||
);
|
||||
}
|
||||
|
||||
$joinColumn->nullable = false;
|
||||
} elseif ($joinColumn->nullable === null) {
|
||||
$joinColumn->nullable = true;
|
||||
@@ -200,7 +215,12 @@ abstract class ToOneOwningSideMapping extends OwningSideMapping implements ToOne
|
||||
|
||||
$joinColumns = [];
|
||||
foreach ($array['joinColumns'] as $column) {
|
||||
$joinColumns[] = (array) $column;
|
||||
$columnArray = (array) $column;
|
||||
if ($this->id) {
|
||||
unset($columnArray['nullable']);
|
||||
}
|
||||
|
||||
$joinColumns[] = $columnArray;
|
||||
}
|
||||
|
||||
$array['joinColumns'] = $joinColumns;
|
||||
|
||||
@@ -160,6 +160,11 @@ EXCEPTION
|
||||
return new self('You must configure a proxy directory. See docs for details');
|
||||
}
|
||||
|
||||
public static function lazyGhostUnavailable(): self
|
||||
{
|
||||
return new self('Symfony LazyGhost is not available. Please install the "symfony/var-exporter" package version 6.4 or 7 to use this feature or enable PHP 8.4 native lazy objects.');
|
||||
}
|
||||
|
||||
public static function proxyNamespaceRequired(): self
|
||||
{
|
||||
return new self('You must configure a proxy namespace');
|
||||
|
||||
+5
-4
@@ -7,6 +7,7 @@ namespace Doctrine\ORM;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
|
||||
use Doctrine\ORM\Mapping\Driver\XmlDriver;
|
||||
use Doctrine\Persistence\Mapping\Driver\ClassLocator;
|
||||
use Psr\Cache\CacheItemPoolInterface;
|
||||
use Redis;
|
||||
use RuntimeException;
|
||||
@@ -28,10 +29,10 @@ final class ORMSetup
|
||||
/**
|
||||
* Creates a configuration with an attribute metadata driver.
|
||||
*
|
||||
* @param string[] $paths
|
||||
* @param string[]|ClassLocator $paths
|
||||
*/
|
||||
public static function createAttributeMetadataConfiguration(
|
||||
array $paths,
|
||||
array|ClassLocator $paths,
|
||||
bool $isDevMode = false,
|
||||
string|null $proxyDir = null,
|
||||
CacheItemPoolInterface|null $cache = null,
|
||||
@@ -55,10 +56,10 @@ final class ORMSetup
|
||||
/**
|
||||
* Creates a configuration with an attribute metadata driver.
|
||||
*
|
||||
* @param string[] $paths
|
||||
* @param string[]|ClassLocator $paths
|
||||
*/
|
||||
public static function createAttributeMetadataConfig(
|
||||
array $paths,
|
||||
array|ClassLocator $paths,
|
||||
bool $isDevMode = false,
|
||||
string|null $cacheNamespaceSeed = null,
|
||||
CacheItemPoolInterface|null $cache = null,
|
||||
|
||||
@@ -42,6 +42,8 @@ use function strtoupper;
|
||||
*/
|
||||
final class PersistentCollection extends AbstractLazyCollection implements Selectable
|
||||
{
|
||||
use PersistentCollectionImplementation;
|
||||
|
||||
/**
|
||||
* A snapshot of the collection at the moment it was fetched from the database.
|
||||
* This is used to create a diff of the collection at commit time.
|
||||
@@ -402,7 +404,7 @@ final class PersistentCollection extends AbstractLazyCollection implements Selec
|
||||
}
|
||||
}
|
||||
|
||||
public function add(mixed $value): bool
|
||||
private function doAdd(mixed $value): void
|
||||
{
|
||||
$this->unwrap()->add($value);
|
||||
|
||||
@@ -411,8 +413,6 @@ final class PersistentCollection extends AbstractLazyCollection implements Selec
|
||||
if (is_object($value) && $this->em) {
|
||||
$this->getUnitOfWork()->cancelOrphanRemoval($value);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public function offsetExists(mixed $offset): bool
|
||||
@@ -504,10 +504,8 @@ final class PersistentCollection extends AbstractLazyCollection implements Selec
|
||||
$this->em = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function first()
|
||||
/** {@inheritDoc} */
|
||||
public function first(): mixed
|
||||
{
|
||||
if (! $this->initialized && ! $this->isDirty && $this->getMapping()->fetch === ClassMetadata::FETCH_EXTRA_LAZY) {
|
||||
$persister = $this->getUnitOfWork()->getCollectionPersister($this->getMapping());
|
||||
@@ -618,7 +616,6 @@ final class PersistentCollection extends AbstractLazyCollection implements Selec
|
||||
public function unwrap(): Selectable&Collection
|
||||
{
|
||||
assert($this->collection instanceof Collection);
|
||||
assert($this->collection instanceof Selectable);
|
||||
|
||||
return $this->collection;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM;
|
||||
|
||||
use Doctrine\Common\Collections\Criteria;
|
||||
|
||||
use function defined;
|
||||
|
||||
if (defined(Criteria::class . '::ASC')) {
|
||||
// collections 2
|
||||
/** @internal */
|
||||
trait PersistentCollectionImplementation
|
||||
{
|
||||
abstract private function doAdd(mixed $value): void;
|
||||
|
||||
public function add(mixed $value): bool
|
||||
{
|
||||
$this->doAdd($value);
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// collections 3
|
||||
/** @internal */
|
||||
trait PersistentCollectionImplementation
|
||||
{
|
||||
abstract private function doAdd(mixed $value): void;
|
||||
|
||||
public function add(mixed $value): void
|
||||
{
|
||||
$this->doAdd($value);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -25,6 +25,8 @@ interface CollectionPersister
|
||||
|
||||
/**
|
||||
* Counts the size of this persistent collection.
|
||||
*
|
||||
* @return non-negative-int
|
||||
*/
|
||||
public function count(PersistentCollection $collection): int;
|
||||
|
||||
|
||||
@@ -106,6 +106,7 @@ class ManyToManyPersister extends AbstractCollectionPersister
|
||||
);
|
||||
}
|
||||
|
||||
/** @return non-negative-int */
|
||||
public function count(PersistentCollection $collection): int
|
||||
{
|
||||
$conditions = [];
|
||||
|
||||
@@ -20,6 +20,7 @@ use function array_reverse;
|
||||
use function array_values;
|
||||
use function assert;
|
||||
use function count;
|
||||
use function defined;
|
||||
use function implode;
|
||||
use function is_int;
|
||||
use function is_string;
|
||||
@@ -86,10 +87,13 @@ class OneToManyPersister extends AbstractCollectionPersister
|
||||
$mapping = $this->getMapping($collection);
|
||||
$persister = $this->uow->getEntityPersister($mapping->targetEntity);
|
||||
|
||||
// Doctrine Collections 2.x support
|
||||
$criteria = defined(Criteria::class . '::ASC') ? Criteria::create(true) : Criteria::create();
|
||||
|
||||
// only works with single id identifier entities. Will throw an
|
||||
// exception in Entity Persisters if that is not the case for the
|
||||
// 'mappedBy' field.
|
||||
$criteria = Criteria::create(true)->where(Criteria::expr()->eq($mapping->mappedBy, $collection->getOwner()));
|
||||
$criteria = $criteria->where(Criteria::expr()->eq($mapping->mappedBy, $collection->getOwner()));
|
||||
|
||||
return $persister->count($criteria);
|
||||
}
|
||||
@@ -118,7 +122,8 @@ class OneToManyPersister extends AbstractCollectionPersister
|
||||
// only works with single id identifier entities. Will throw an
|
||||
// exception in Entity Persisters if that is not the case for the
|
||||
// 'mappedBy' field.
|
||||
$criteria = Criteria::create(true);
|
||||
// Doctrine Collections 2.x support
|
||||
$criteria = defined(Criteria::class . '::ASC') ? Criteria::create(true) : Criteria::create();
|
||||
|
||||
$criteria->andWhere(Criteria::expr()->eq($mapping->mappedBy, $collection->getOwner()));
|
||||
$criteria->andWhere(Criteria::expr()->eq($mapping->indexBy(), $key));
|
||||
@@ -135,10 +140,12 @@ class OneToManyPersister extends AbstractCollectionPersister
|
||||
$mapping = $this->getMapping($collection);
|
||||
$persister = $this->uow->getEntityPersister($mapping->targetEntity);
|
||||
|
||||
// Doctrine Collections 2.x support
|
||||
$criteria = defined(Criteria::class . '::ASC') ? Criteria::create(true) : Criteria::create();
|
||||
// only works with single id identifier entities. Will throw an
|
||||
// exception in Entity Persisters if that is not the case for the
|
||||
// 'mappedBy' field.
|
||||
$criteria = Criteria::create(true)->where(Criteria::expr()->eq($mapping->mappedBy, $collection->getOwner()));
|
||||
$criteria = $criteria->where(Criteria::expr()->eq($mapping->mappedBy, $collection->getOwner()));
|
||||
|
||||
return $persister->exists($element, $criteria);
|
||||
}
|
||||
|
||||
@@ -40,13 +40,21 @@ abstract class AbstractEntityInheritancePersister extends BasicEntityPersister
|
||||
{
|
||||
$tableAlias = $alias === 'r' ? '' : $alias;
|
||||
$fieldMapping = $class->fieldMappings[$field];
|
||||
$columnAlias = $this->getSQLColumnAlias($fieldMapping->columnName);
|
||||
$sql = sprintf(
|
||||
'%s.%s',
|
||||
$this->getSQLTableAlias($class->name, $tableAlias),
|
||||
$this->quoteStrategy->getColumnName($field, $class, $this->platform),
|
||||
);
|
||||
|
||||
$columnAlias = null;
|
||||
if ($this->currentPersisterContext->rsm->hasColumnAliasByField($alias, $field)) {
|
||||
$columnAlias = $this->currentPersisterContext->rsm->getColumnAliasByField($alias, $field);
|
||||
}
|
||||
|
||||
if ($columnAlias === null) {
|
||||
$columnAlias = $this->getSQLColumnAlias($fieldMapping->columnName);
|
||||
}
|
||||
|
||||
$this->currentPersisterContext->rsm->addFieldResult($alias, $columnAlias, $field, $class->name);
|
||||
|
||||
$type = Type::getType($fieldMapping->type);
|
||||
|
||||
@@ -1668,6 +1668,11 @@ class BasicEntityPersister implements EntityPersister
|
||||
$value = [$value];
|
||||
}
|
||||
|
||||
if ($value === []) {
|
||||
$selectedColumns[] = '1=0';
|
||||
continue;
|
||||
}
|
||||
|
||||
$nullKeys = array_keys($value, null, true);
|
||||
$nonNullValues = array_diff_key($value, array_flip($nullKeys));
|
||||
|
||||
|
||||
@@ -7,25 +7,21 @@ namespace Doctrine\ORM\Persisters;
|
||||
use Doctrine\Common\Collections\Expr\Comparison;
|
||||
use Doctrine\Common\Collections\Expr\CompositeExpression;
|
||||
use Doctrine\Common\Collections\Expr\ExpressionVisitor;
|
||||
use Doctrine\Common\Collections\Expr\Value;
|
||||
|
||||
/**
|
||||
* Extract the values from a criteria/expression
|
||||
*/
|
||||
class SqlValueVisitor extends ExpressionVisitor
|
||||
{
|
||||
use SqlValueVisitorImplementation;
|
||||
|
||||
/** @var mixed[] */
|
||||
private array $values = [];
|
||||
|
||||
/** @var mixed[][] */
|
||||
private array $types = [];
|
||||
|
||||
/**
|
||||
* Converts a comparison expression into the target query language output.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function walkComparison(Comparison $comparison)
|
||||
private function doWalkComparison(Comparison $comparison): mixed
|
||||
{
|
||||
$value = $this->getValueFromComparison($comparison);
|
||||
|
||||
@@ -35,12 +31,7 @@ class SqlValueVisitor extends ExpressionVisitor
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a composite expression into the target query language output.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function walkCompositeExpression(CompositeExpression $expr)
|
||||
private function doWalkCompositeExpression(CompositeExpression $expr): mixed
|
||||
{
|
||||
foreach ($expr->getExpressionList() as $child) {
|
||||
$this->dispatch($child);
|
||||
@@ -49,16 +40,6 @@ class SqlValueVisitor extends ExpressionVisitor
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a value expression into the target query language part.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function walkValue(Value $value)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Parameters and Types necessary for matching the last visited expression.
|
||||
*
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Persisters;
|
||||
|
||||
use Doctrine\Common\Collections\Criteria;
|
||||
use Doctrine\Common\Collections\Expr\Comparison;
|
||||
use Doctrine\Common\Collections\Expr\CompositeExpression;
|
||||
use Doctrine\Common\Collections\Expr\Value;
|
||||
|
||||
use function defined;
|
||||
|
||||
if (defined(Criteria::class . '::ASC')) {
|
||||
// collections 2
|
||||
/** @internal */
|
||||
trait SqlValueVisitorImplementation
|
||||
{
|
||||
abstract private function doWalkComparison(Comparison $comparison): mixed;
|
||||
|
||||
abstract private function doWalkCompositeExpression(CompositeExpression $comparison): mixed;
|
||||
|
||||
/**
|
||||
* Converts a comparison expression into the target query language output.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @phpstan-ignore missingType.return
|
||||
*/
|
||||
public function walkComparison(Comparison $comparison)
|
||||
{
|
||||
return $this->doWalkComparison($comparison);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a value expression into the target query language part.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @phpstan-ignore missingType.return
|
||||
*/
|
||||
public function walkValue(Value $value)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a composite expression into the target query language output.
|
||||
*
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @phpstan-ignore missingType.return
|
||||
*/
|
||||
public function walkCompositeExpression(CompositeExpression $expr)
|
||||
{
|
||||
return $this->doWalkCompositeExpression($expr);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// collections 3
|
||||
/** @internal */
|
||||
trait SqlValueVisitorImplementation
|
||||
{
|
||||
abstract private function doWalkComparison(Comparison $comparison): mixed;
|
||||
|
||||
abstract private function doWalkCompositeExpression(CompositeExpression $comparison): mixed;
|
||||
|
||||
/** Converts a comparison expression into the target query language output. */
|
||||
public function walkComparison(Comparison $comparison): mixed
|
||||
{
|
||||
return $this->doWalkComparison($comparison);
|
||||
}
|
||||
|
||||
/** Converts a value expression into the target query language part. */
|
||||
public function walkValue(Value $value): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Converts a composite expression into the target query language output. */
|
||||
public function walkCompositeExpression(CompositeExpression $expr): mixed
|
||||
{
|
||||
return $this->doWalkCompositeExpression($expr);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -37,6 +37,7 @@ use function is_dir;
|
||||
use function is_int;
|
||||
use function is_writable;
|
||||
use function ltrim;
|
||||
use function method_exists;
|
||||
use function mkdir;
|
||||
use function preg_match_all;
|
||||
use function random_bytes;
|
||||
@@ -161,6 +162,11 @@ EOPHP;
|
||||
);
|
||||
}
|
||||
|
||||
// @phpstan-ignore function.impossibleType (This method has been removed in Symfony 8)
|
||||
if (! method_exists(ProxyHelper::class, 'generateLazyGhost')) {
|
||||
throw ORMInvalidArgumentException::lazyGhostUnavailable();
|
||||
}
|
||||
|
||||
if (! $proxyDir) {
|
||||
throw ORMInvalidArgumentException::proxyDirectoryRequired();
|
||||
}
|
||||
@@ -464,7 +470,7 @@ EOPHP;
|
||||
|
||||
private function generateUseLazyGhostTrait(ClassMetadata $class): string
|
||||
{
|
||||
// @phpstan-ignore staticMethod.deprecated (Because we support Symfony < 7.3)
|
||||
// @phpstan-ignore staticMethod.notFound (This method has been removed in Symfony 8)
|
||||
$code = ProxyHelper::generateLazyGhost($class->getReflectionClass());
|
||||
$code = substr($code, 7 + (int) strpos($code, "\n{"));
|
||||
$code = substr($code, 0, (int) strpos($code, "\n}"));
|
||||
|
||||
@@ -6,18 +6,28 @@ namespace Doctrine\ORM\Query\Exec;
|
||||
|
||||
use Doctrine\DBAL\Connection;
|
||||
use Doctrine\DBAL\Result;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\Query\AST\SelectStatement;
|
||||
use Doctrine\ORM\Query\SqlWalker;
|
||||
|
||||
/**
|
||||
* Executor that executes the SQL statement for simple DQL SELECT statements.
|
||||
*
|
||||
* @deprecated This class is no longer needed by the ORM and will be removed in 4.0.
|
||||
*
|
||||
* @link www.doctrine-project.org
|
||||
*/
|
||||
class SingleSelectExecutor extends AbstractSqlExecutor
|
||||
{
|
||||
public function __construct(SelectStatement $AST, SqlWalker $sqlWalker)
|
||||
{
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/11188/',
|
||||
'The %s is no longer needed by the ORM and will be removed in 4.0',
|
||||
self::class,
|
||||
);
|
||||
|
||||
$this->sqlStatements = $sqlWalker->walkSelectStatement($AST);
|
||||
}
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Query\Expr;
|
||||
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* Expression class for building DQL and parts.
|
||||
*
|
||||
@@ -13,7 +15,7 @@ class Andx extends Composite
|
||||
{
|
||||
protected string $separator = ' AND ';
|
||||
|
||||
/** @var string[] */
|
||||
/** @var list<class-string<Stringable>> */
|
||||
protected array $allowedClasses = [
|
||||
Comparison::class,
|
||||
Func::class,
|
||||
|
||||
@@ -13,6 +13,7 @@ use function get_debug_type;
|
||||
use function implode;
|
||||
use function in_array;
|
||||
use function is_array;
|
||||
use function is_object;
|
||||
use function is_string;
|
||||
use function sprintf;
|
||||
|
||||
@@ -27,7 +28,7 @@ abstract class Base implements Stringable
|
||||
protected string $separator = ', ';
|
||||
protected string $postSeparator = ')';
|
||||
|
||||
/** @var list<class-string> */
|
||||
/** @var list<class-string<Stringable>> */
|
||||
protected array $allowedClasses = [];
|
||||
|
||||
/** @var list<string|Stringable> */
|
||||
@@ -58,6 +59,8 @@ abstract class Base implements Stringable
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|Stringable|null $arg
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @throws InvalidArgumentException
|
||||
@@ -66,7 +69,8 @@ abstract class Base implements Stringable
|
||||
{
|
||||
if ($arg !== null && (! $arg instanceof self || $arg->count() > 0)) {
|
||||
// If we decide to keep Expr\Base instances, we can use this check
|
||||
if (! is_string($arg) && ! in_array($arg::class, $this->allowedClasses, true)) {
|
||||
// @phpstan-ignore function.alreadyNarrowedType (input validation)
|
||||
if (! is_string($arg) && ! (is_object($arg) && in_array($arg::class, $this->allowedClasses, true))) {
|
||||
throw new InvalidArgumentException(sprintf(
|
||||
"Expression of type '%s' not allowed in this context.",
|
||||
get_debug_type($arg),
|
||||
|
||||
@@ -4,6 +4,8 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Query\Expr;
|
||||
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* Expression class for building DQL OR clauses.
|
||||
*
|
||||
@@ -13,7 +15,7 @@ class Orx extends Composite
|
||||
{
|
||||
protected string $separator = ' OR ';
|
||||
|
||||
/** @var string[] */
|
||||
/** @var list<class-string<Stringable>> */
|
||||
protected array $allowedClasses = [
|
||||
Comparison::class,
|
||||
Func::class,
|
||||
|
||||
@@ -4,6 +4,8 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Query\Expr;
|
||||
|
||||
use Stringable;
|
||||
|
||||
/**
|
||||
* Expression class for building DQL select statements.
|
||||
*
|
||||
@@ -14,7 +16,7 @@ class Select extends Base
|
||||
protected string $preSeparator = '';
|
||||
protected string $postSeparator = '';
|
||||
|
||||
/** @var string[] */
|
||||
/** @var list<class-string<Stringable>> */
|
||||
protected array $allowedClasses = [Func::class];
|
||||
|
||||
/** @phpstan-var list<string|Func> */
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Query\Filter;
|
||||
|
||||
use Doctrine\DBAL\ArrayParameterType;
|
||||
use Doctrine\DBAL\ParameterType;
|
||||
|
||||
/** @internal */
|
||||
final class Parameter
|
||||
{
|
||||
/** @param ParameterType::*|ArrayParameterType::*|string $type */
|
||||
public function __construct(
|
||||
public readonly mixed $value,
|
||||
public readonly ParameterType|ArrayParameterType|int|string $type,
|
||||
public readonly bool $isList,
|
||||
) {
|
||||
}
|
||||
}
|
||||
@@ -29,7 +29,7 @@ abstract class SQLFilter implements Stringable
|
||||
/**
|
||||
* Parameters for the filter.
|
||||
*
|
||||
* @phpstan-var array<string,array{type: string, value: mixed, is_list: bool}>
|
||||
* @phpstan-var array<string, Parameter>
|
||||
*/
|
||||
private array $parameters = [];
|
||||
|
||||
@@ -49,7 +49,7 @@ abstract class SQLFilter implements Stringable
|
||||
*/
|
||||
final public function setParameterList(string $name, array $values, string $type = Types::STRING): static
|
||||
{
|
||||
$this->parameters[$name] = ['value' => $values, 'type' => $type, 'is_list' => true];
|
||||
$this->parameters[$name] = new Parameter(value: $values, type: $type, isList: true);
|
||||
|
||||
// Keep the parameters sorted for the hash
|
||||
ksort($this->parameters);
|
||||
@@ -71,11 +71,11 @@ abstract class SQLFilter implements Stringable
|
||||
*/
|
||||
final public function setParameter(string $name, mixed $value, string|null $type = null): static
|
||||
{
|
||||
if ($type === null) {
|
||||
$type = ParameterTypeInferer::inferType($value);
|
||||
}
|
||||
|
||||
$this->parameters[$name] = ['value' => $value, 'type' => $type, 'is_list' => false];
|
||||
$this->parameters[$name] = new Parameter(
|
||||
value: $value,
|
||||
type: $type ?? ParameterTypeInferer::inferType($value),
|
||||
isList: false,
|
||||
);
|
||||
|
||||
// Keep the parameters sorted for the hash
|
||||
ksort($this->parameters);
|
||||
@@ -102,11 +102,11 @@ abstract class SQLFilter implements Stringable
|
||||
throw new InvalidArgumentException("Parameter '" . $name . "' does not exist.");
|
||||
}
|
||||
|
||||
if ($this->parameters[$name]['is_list']) {
|
||||
if ($this->parameters[$name]->isList) {
|
||||
throw FilterException::cannotConvertListParameterIntoSingleValue($name);
|
||||
}
|
||||
|
||||
return $this->em->getConnection()->quote((string) $this->parameters[$name]['value']);
|
||||
return $this->em->getConnection()->quote((string) $this->parameters[$name]->value);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -124,7 +124,7 @@ abstract class SQLFilter implements Stringable
|
||||
throw new InvalidArgumentException("Parameter '" . $name . "' does not exist.");
|
||||
}
|
||||
|
||||
if ($this->parameters[$name]['is_list'] === false) {
|
||||
if (! $this->parameters[$name]->isList) {
|
||||
throw FilterException::cannotConvertSingleParameterIntoListValue($name);
|
||||
}
|
||||
|
||||
@@ -133,7 +133,7 @@ abstract class SQLFilter implements Stringable
|
||||
|
||||
$quoted = array_map(
|
||||
static fn (mixed $value): string => $connection->quote((string) $value),
|
||||
$param['value'],
|
||||
$param->value,
|
||||
);
|
||||
|
||||
return implode(',', $quoted);
|
||||
@@ -152,7 +152,14 @@ abstract class SQLFilter implements Stringable
|
||||
*/
|
||||
final public function __toString(): string
|
||||
{
|
||||
return serialize($this->parameters);
|
||||
return serialize(array_map(
|
||||
static fn (Parameter $value): array => [
|
||||
'value' => $value->value,
|
||||
'type' => $value->type,
|
||||
'is_list' => $value->isList,
|
||||
],
|
||||
$this->parameters,
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -25,9 +25,9 @@ use function is_int;
|
||||
final class ParameterTypeInferer
|
||||
{
|
||||
/**
|
||||
* Infers type of a given value, returning a compatible constant:
|
||||
* - Type (\Doctrine\DBAL\Types\Type::*)
|
||||
* - Connection (\Doctrine\DBAL\Connection::PARAM_*)
|
||||
* Infers the type of a given value
|
||||
*
|
||||
* @return ParameterType::*|ArrayParameterType::*|Types::*
|
||||
*/
|
||||
public static function inferType(mixed $value): ParameterType|ArrayParameterType|int|string
|
||||
{
|
||||
|
||||
+22
-13
@@ -1609,8 +1609,7 @@ final class Parser
|
||||
|
||||
/**
|
||||
* Join ::= ["LEFT" ["OUTER"] | "INNER"] "JOIN"
|
||||
* (JoinAssociationDeclaration | RangeVariableDeclaration)
|
||||
* ["WITH" ConditionalExpression]
|
||||
* (JoinAssociationDeclaration ["WITH" ConditionalExpression] | RangeVariableDeclaration [("ON" | "WITH") ConditionalExpression])
|
||||
*/
|
||||
public function Join(): AST\Join
|
||||
{
|
||||
@@ -1644,21 +1643,31 @@ final class Parser
|
||||
|
||||
$next = $this->lexer->glimpse();
|
||||
assert($next !== null);
|
||||
$joinDeclaration = $next->type === TokenType::T_DOT ? $this->JoinAssociationDeclaration() : $this->RangeVariableDeclaration();
|
||||
$adhocConditions = $this->lexer->isNextToken(TokenType::T_WITH);
|
||||
$join = new AST\Join($joinType, $joinDeclaration);
|
||||
$conditionalExpression = null;
|
||||
|
||||
// Describe non-root join declaration
|
||||
if ($joinDeclaration instanceof AST\RangeVariableDeclaration) {
|
||||
if ($next->type === TokenType::T_DOT) {
|
||||
$joinDeclaration = $this->JoinAssociationDeclaration();
|
||||
|
||||
if ($this->lexer->isNextToken(TokenType::T_WITH)) {
|
||||
$this->match(TokenType::T_WITH);
|
||||
$conditionalExpression = $this->ConditionalExpression();
|
||||
}
|
||||
} else {
|
||||
$joinDeclaration = $this->RangeVariableDeclaration();
|
||||
$joinDeclaration->isRoot = false;
|
||||
|
||||
if ($this->lexer->isNextToken(TokenType::T_ON)) {
|
||||
$this->match(TokenType::T_ON);
|
||||
$conditionalExpression = $this->ConditionalExpression();
|
||||
} elseif ($this->lexer->isNextToken(TokenType::T_WITH)) {
|
||||
$this->match(TokenType::T_WITH);
|
||||
$conditionalExpression = $this->ConditionalExpression();
|
||||
Deprecation::trigger('doctrine/orm', 'https://github.com/doctrine/orm/issues/12192', 'Using WITH for the join condition of arbitrary joins is deprecated. Use ON instead.');
|
||||
}
|
||||
}
|
||||
|
||||
// Check for ad-hoc Join conditions
|
||||
if ($adhocConditions) {
|
||||
$this->match(TokenType::T_WITH);
|
||||
|
||||
$join->conditionalExpression = $this->ConditionalExpression();
|
||||
}
|
||||
$join = new AST\Join($joinType, $joinDeclaration);
|
||||
$join->conditionalExpression = $conditionalExpression;
|
||||
|
||||
return $join;
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Query;
|
||||
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\Query;
|
||||
use Doctrine\ORM\Query\Exec\AbstractSqlExecutor;
|
||||
use Doctrine\ORM\Query\Exec\SqlFinalizer;
|
||||
@@ -71,20 +72,36 @@ class ParserResult
|
||||
/**
|
||||
* Sets the SQL executor that should be used for this ParserResult.
|
||||
*
|
||||
* @deprecated
|
||||
* @deprecated The SqlExecutor will be removed from ParserResult in 4.0. Provide a SqlFinalizer instead that can create the executor.
|
||||
*/
|
||||
public function setSqlExecutor(AbstractSqlExecutor $executor): void
|
||||
{
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/11188',
|
||||
'The SqlExecutor will be removed from %s in 4.0. Provide a %s instead that can create the executor.',
|
||||
self::class,
|
||||
SqlFinalizer::class,
|
||||
);
|
||||
|
||||
$this->sqlExecutor = $executor;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the SQL executor used by this ParserResult.
|
||||
*
|
||||
* @deprecated
|
||||
* @deprecated The SqlExecutor will be removed from ParserResult in 4.0. Provide a SqlFinalizer instead that can create the executor.
|
||||
*/
|
||||
public function getSqlExecutor(): AbstractSqlExecutor
|
||||
{
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/11188',
|
||||
'The SqlExecutor will be removed from %s in 4.0. Provide a %s instead that can create the executor.',
|
||||
self::class,
|
||||
SqlFinalizer::class,
|
||||
);
|
||||
|
||||
if ($this->sqlExecutor === null) {
|
||||
throw new LogicException(sprintf(
|
||||
'Executor not set yet. Call %s::setSqlExecutor() first.',
|
||||
|
||||
@@ -363,6 +363,10 @@ class ResultSetMapping
|
||||
|
||||
public function hasColumnAliasByField(string $alias, string $fieldName): bool
|
||||
{
|
||||
if (! isset($this->aliasMap[$alias])) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$declaringClass = $this->aliasMap[$alias];
|
||||
|
||||
return isset($this->columnAliasMappings[$declaringClass][$alias][$fieldName]);
|
||||
|
||||
@@ -9,6 +9,7 @@ use Doctrine\DBAL\Connection;
|
||||
use Doctrine\DBAL\LockMode;
|
||||
use Doctrine\DBAL\Platforms\AbstractPlatform;
|
||||
use Doctrine\DBAL\Types\Type;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\QuoteStrategy;
|
||||
@@ -230,6 +231,14 @@ class SqlWalker
|
||||
*/
|
||||
public function getExecutor(AST\SelectStatement|AST\UpdateStatement|AST\DeleteStatement $statement): Exec\AbstractSqlExecutor
|
||||
{
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/11188/',
|
||||
'Output walkers should implement %s. That way, the %s method is no longer needed and will be removed in 4.0',
|
||||
OutputWalker::class,
|
||||
__METHOD__,
|
||||
);
|
||||
|
||||
return match (true) {
|
||||
$statement instanceof AST\UpdateStatement => $this->createUpdateStatementExecutor($statement),
|
||||
$statement instanceof AST\DeleteStatement => $this->createDeleteStatementExecutor($statement),
|
||||
|
||||
@@ -90,4 +90,5 @@ enum TokenType: int
|
||||
case T_WHERE = 255;
|
||||
case T_WITH = 256;
|
||||
case T_NAMED = 257;
|
||||
case T_ON = 258;
|
||||
}
|
||||
|
||||
+71
-6
@@ -8,6 +8,7 @@ use Doctrine\Common\Collections\ArrayCollection;
|
||||
use Doctrine\Common\Collections\Criteria;
|
||||
use Doctrine\DBAL\ArrayParameterType;
|
||||
use Doctrine\DBAL\ParameterType;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\Internal\NoUnknownNamedArguments;
|
||||
use Doctrine\ORM\Query\Expr;
|
||||
use Doctrine\ORM\Query\Parameter;
|
||||
@@ -116,6 +117,13 @@ class QueryBuilder implements Stringable
|
||||
*/
|
||||
private int $boundCounter = 0;
|
||||
|
||||
/**
|
||||
* The hints to set on the query.
|
||||
*
|
||||
* @var array<string, string|int|bool|iterable<mixed>|object>
|
||||
*/
|
||||
private array $hints = [];
|
||||
|
||||
/**
|
||||
* Initializes a new <tt>QueryBuilder</tt> that uses the given <tt>EntityManager</tt>.
|
||||
*
|
||||
@@ -207,6 +215,39 @@ class QueryBuilder implements Stringable
|
||||
return $this;
|
||||
}
|
||||
|
||||
/** @return array<string, string|int|bool|iterable<mixed>|object> */
|
||||
public function getHints(): array
|
||||
{
|
||||
return $this->hints;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a query hint. If the hint name is not recognized, FALSE is returned.
|
||||
*
|
||||
* @return mixed The value of the hint or FALSE, if the hint name is not recognized.
|
||||
*/
|
||||
public function getHint(string $name): mixed
|
||||
{
|
||||
return $this->hints[$name] ?? false;
|
||||
}
|
||||
|
||||
public function hasHint(string $name): bool
|
||||
{
|
||||
return isset($this->hints[$name]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds hints for the query.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function setHint(string $name, mixed $value): static
|
||||
{
|
||||
$this->hints[$name] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/** @phpstan-return Cache::MODE_*|null */
|
||||
public function getCacheMode(): int|null
|
||||
{
|
||||
@@ -287,6 +328,10 @@ class QueryBuilder implements Stringable
|
||||
$query->setCacheRegion($this->cacheRegion);
|
||||
}
|
||||
|
||||
foreach ($this->hints as $name => $value) {
|
||||
$query->setHint($name, $value);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
@@ -305,8 +350,13 @@ class QueryBuilder implements Stringable
|
||||
} else {
|
||||
// Should never happen with correct joining order. Might be
|
||||
// thoughtful to throw exception instead.
|
||||
// @phpstan-ignore method.deprecated
|
||||
$rootAlias = $this->getRootAlias();
|
||||
$aliases = $this->getRootAliases();
|
||||
|
||||
if (! isset($aliases[0])) {
|
||||
throw new RuntimeException('No alias was set before invoking getRootAlias().');
|
||||
}
|
||||
|
||||
$rootAlias = $aliases[0];
|
||||
}
|
||||
|
||||
$this->joinRootAliases[$alias] = $rootAlias;
|
||||
@@ -541,6 +591,10 @@ class QueryBuilder implements Stringable
|
||||
*/
|
||||
public function setMaxResults(int|null $maxResults): static
|
||||
{
|
||||
if ($this->type === QueryType::Delete || $this->type === QueryType::Update) {
|
||||
throw new RuntimeException('Setting a limit is not supported for delete or update queries.');
|
||||
}
|
||||
|
||||
$this->maxResults = $maxResults;
|
||||
|
||||
return $this;
|
||||
@@ -582,14 +636,25 @@ class QueryBuilder implements Stringable
|
||||
$dqlPart = reset($dqlPart);
|
||||
}
|
||||
|
||||
// This is introduced for backwards compatibility reasons.
|
||||
// TODO: Remove for 3.0
|
||||
if ($dqlPartName === 'join') {
|
||||
$newDqlPart = [];
|
||||
|
||||
foreach ($dqlPart as $k => $v) {
|
||||
// @phpstan-ignore method.deprecated
|
||||
$k = is_numeric($k) ? $this->getRootAlias() : $k;
|
||||
if (is_numeric($k)) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/pull/12051',
|
||||
'Using numeric keys in %s for join parts is deprecated and will not be supported in 4.0. Use an associative array with the root alias as key instead.',
|
||||
__METHOD__,
|
||||
);
|
||||
$aliases = $this->getRootAliases();
|
||||
|
||||
if (! isset($aliases[0])) {
|
||||
throw new RuntimeException('No alias was set before invoking add().');
|
||||
}
|
||||
|
||||
$k = $aliases[0];
|
||||
}
|
||||
|
||||
$newDqlPart[$k] = $v;
|
||||
}
|
||||
|
||||
@@ -18,11 +18,12 @@ trait ApplicationCompatibility
|
||||
{
|
||||
private static function addCommandToApplication(Application $application, Command $command): Command|null
|
||||
{
|
||||
// @phpstan-ignore function.alreadyNarrowedType (This method did not exist before Symfony 7.4)
|
||||
if (method_exists(Application::class, 'addCommand')) {
|
||||
// @phpstan-ignore method.notFound (This method will be added in Symfony 7.4)
|
||||
return $application->addCommand($command);
|
||||
}
|
||||
|
||||
// @phpstan-ignore method.notFound
|
||||
return $application->add($command);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\Console\Command\Debug;
|
||||
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\Persistence\ManagerRegistry;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
|
||||
use function assert;
|
||||
|
||||
/** @internal */
|
||||
abstract class AbstractCommand extends Command
|
||||
{
|
||||
public function __construct(private readonly ManagerRegistry $managerRegistry)
|
||||
{
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
final protected function getEntityManager(string $name): EntityManagerInterface
|
||||
{
|
||||
$manager = $this->getManagerRegistry()->getManager($name);
|
||||
|
||||
assert($manager instanceof EntityManagerInterface);
|
||||
|
||||
return $manager;
|
||||
}
|
||||
|
||||
final protected function getManagerRegistry(): ManagerRegistry
|
||||
{
|
||||
return $this->managerRegistry;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\Console\Command\Debug;
|
||||
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Symfony\Component\Console\Completion\CompletionInput;
|
||||
use Symfony\Component\Console\Completion\CompletionSuggestions;
|
||||
use Symfony\Component\Console\Helper\TableSeparator;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
|
||||
use function array_keys;
|
||||
use function array_merge;
|
||||
use function array_unique;
|
||||
use function array_values;
|
||||
use function assert;
|
||||
use function class_exists;
|
||||
use function ksort;
|
||||
use function ltrim;
|
||||
use function sort;
|
||||
use function sprintf;
|
||||
|
||||
final class DebugEntityListenersDoctrineCommand extends AbstractCommand
|
||||
{
|
||||
protected function configure(): void
|
||||
{
|
||||
$this
|
||||
->setName('orm:debug:entity-listeners')
|
||||
->setDescription('Lists entity listeners for a given entity')
|
||||
->addArgument('entity', InputArgument::OPTIONAL, 'The fully-qualified entity class name')
|
||||
->addArgument('event', InputArgument::OPTIONAL, 'The event name to filter by (e.g. postPersist)')
|
||||
->setHelp(<<<'EOT'
|
||||
The <info>%command.name%</info> command lists all entity listeners for a given entity:
|
||||
|
||||
<info>php %command.full_name% 'App\Entity\User'</info>
|
||||
|
||||
To show only listeners for a specific event, pass the event name:
|
||||
|
||||
<info>php %command.full_name% 'App\Entity\User' postPersist</info>
|
||||
EOT);
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$io = new SymfonyStyle($input, $output);
|
||||
|
||||
/** @var class-string|null $entityName */
|
||||
$entityName = $input->getArgument('entity');
|
||||
|
||||
if ($entityName === null) {
|
||||
$choices = $this->listAllEntities();
|
||||
|
||||
if ($choices === []) {
|
||||
$io->error('No entities are configured.');
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
/** @var class-string $entityName */
|
||||
$entityName = $io->choice('Which entity do you want to list listeners for?', $choices);
|
||||
}
|
||||
|
||||
$entityName = ltrim($entityName, '\\');
|
||||
$entityManager = $this->getManagerRegistry()->getManagerForClass($entityName);
|
||||
|
||||
if ($entityManager === null) {
|
||||
$io->error(sprintf('No entity manager found for class "%s".', $entityName));
|
||||
|
||||
return self::FAILURE;
|
||||
}
|
||||
|
||||
$classMetadata = $entityManager->getClassMetadata($entityName);
|
||||
assert($classMetadata instanceof ClassMetadata);
|
||||
|
||||
$eventName = $input->getArgument('event');
|
||||
|
||||
if ($eventName === null) {
|
||||
$allListeners = $classMetadata->entityListeners;
|
||||
if (! $allListeners) {
|
||||
$io->info(sprintf('No listeners are configured for the "%s" entity.', $entityName));
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
ksort($allListeners);
|
||||
} else {
|
||||
if (! isset($classMetadata->entityListeners[$eventName])) {
|
||||
$io->info(sprintf('No listeners are configured for the "%s" event.', $eventName));
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
$allListeners = [$eventName => $classMetadata->entityListeners[$eventName]];
|
||||
}
|
||||
|
||||
$io->title(sprintf('Entity listeners for <info>%s</info>', $entityName));
|
||||
|
||||
$rows = [];
|
||||
foreach ($allListeners as $event => $listeners) {
|
||||
if ($rows) {
|
||||
$rows[] = new TableSeparator();
|
||||
}
|
||||
|
||||
foreach ($listeners as $order => $listener) {
|
||||
$rows[] = [$order === 0 ? $event : '', sprintf('#%d', ++$order), sprintf('%s::%s()', $listener['class'], $listener['method'])];
|
||||
}
|
||||
}
|
||||
|
||||
$io->table(['Event', 'Order', 'Listener'], $rows);
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
|
||||
{
|
||||
if ($input->mustSuggestArgumentValuesFor('entity')) {
|
||||
$suggestions->suggestValues($this->listAllEntities());
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($input->mustSuggestArgumentValuesFor('event')) {
|
||||
$entityName = ltrim($input->getArgument('entity'), '\\');
|
||||
|
||||
if (! class_exists($entityName)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$entityManager = $this->getManagerRegistry()->getManagerForClass($entityName);
|
||||
|
||||
if ($entityManager === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$classMetadata = $entityManager->getClassMetadata($entityName);
|
||||
assert($classMetadata instanceof ClassMetadata);
|
||||
|
||||
$suggestions->suggestValues(array_keys($classMetadata->entityListeners));
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/** @return list<class-string> */
|
||||
private function listAllEntities(): array
|
||||
{
|
||||
$entities = [];
|
||||
foreach (array_keys($this->getManagerRegistry()->getManagerNames()) as $managerName) {
|
||||
$entities[] = $this->getEntityManager($managerName)->getConfiguration()->getMetadataDriverImpl()->getAllClassNames();
|
||||
}
|
||||
|
||||
$entities = array_values(array_unique(array_merge(...$entities)));
|
||||
|
||||
sort($entities);
|
||||
|
||||
return $entities;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\Console\Command\Debug;
|
||||
|
||||
use Symfony\Component\Console\Completion\CompletionInput;
|
||||
use Symfony\Component\Console\Completion\CompletionSuggestions;
|
||||
use Symfony\Component\Console\Helper\TableSeparator;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
|
||||
use function array_keys;
|
||||
use function array_values;
|
||||
use function ksort;
|
||||
use function method_exists;
|
||||
use function sprintf;
|
||||
|
||||
final class DebugEventManagerDoctrineCommand extends AbstractCommand
|
||||
{
|
||||
protected function configure(): void
|
||||
{
|
||||
$this
|
||||
->setName('orm:debug:event-manager')
|
||||
->setDescription('Lists event listeners for an entity manager')
|
||||
->addArgument('event', InputArgument::OPTIONAL, 'The event name to filter by (e.g. postPersist)')
|
||||
->addOption('em', null, InputOption::VALUE_REQUIRED, 'The entity manager to use for this command')
|
||||
->setHelp(<<<'EOT'
|
||||
The <info>%command.name%</info> command lists all event listeners for the default entity manager:
|
||||
|
||||
<info>php %command.full_name%</info>
|
||||
|
||||
You can also specify an entity manager:
|
||||
|
||||
<info>php %command.full_name% --em=default</info>
|
||||
|
||||
To show only listeners for a specific event, pass the event name as an argument:
|
||||
|
||||
<info>php %command.full_name% postPersist</info>
|
||||
EOT);
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$io = new SymfonyStyle($input, $output);
|
||||
|
||||
$entityManagerName = $input->getOption('em') ?: $this->getManagerRegistry()->getDefaultManagerName();
|
||||
$eventManager = $this->getEntityManager($entityManagerName)->getEventManager();
|
||||
|
||||
$eventName = $input->getArgument('event');
|
||||
|
||||
if ($eventName === null) {
|
||||
$allListeners = $eventManager->getAllListeners();
|
||||
if (! $allListeners) {
|
||||
$io->info(sprintf('No listeners are configured for the "%s" entity manager.', $entityManagerName));
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
ksort($allListeners);
|
||||
} else {
|
||||
$listeners = $eventManager->getListeners($eventName);
|
||||
if (! $listeners) {
|
||||
$io->info(sprintf('No listeners are configured for the "%s" event.', $eventName));
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
$allListeners = [$eventName => $listeners];
|
||||
}
|
||||
|
||||
$io->title(sprintf('Event listeners for <info>%s</info> entity manager', $entityManagerName));
|
||||
|
||||
$rows = [];
|
||||
foreach ($allListeners as $event => $listeners) {
|
||||
if ($rows) {
|
||||
$rows[] = new TableSeparator();
|
||||
}
|
||||
|
||||
foreach (array_values($listeners) as $order => $listener) {
|
||||
$method = method_exists($listener, '__invoke') ? '__invoke' : $event;
|
||||
$rows[] = [$order === 0 ? $event : '', sprintf('#%d', ++$order), sprintf('%s::%s()', $listener::class, $method)];
|
||||
}
|
||||
}
|
||||
|
||||
$io->table(['Event', 'Order', 'Listener'], $rows);
|
||||
|
||||
return self::SUCCESS;
|
||||
}
|
||||
|
||||
public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
|
||||
{
|
||||
if ($input->mustSuggestArgumentValuesFor('event')) {
|
||||
$entityManagerName = $input->getOption('em') ?: $this->getManagerRegistry()->getDefaultManagerName();
|
||||
$eventManager = $this->getEntityManager($entityManagerName)->getEventManager();
|
||||
|
||||
$suggestions->suggestValues(array_keys($eventManager->getAllListeners()));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if ($input->mustSuggestOptionValuesFor('em')) {
|
||||
$suggestions->suggestValues(array_keys($this->getManagerRegistry()->getManagerNames()));
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -10,6 +10,7 @@ use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Mapping\FieldMapping;
|
||||
use Doctrine\Persistence\Mapping\MappingException;
|
||||
use InvalidArgumentException;
|
||||
use JsonException;
|
||||
use Symfony\Component\Console\Completion\CompletionInput;
|
||||
use Symfony\Component\Console\Completion\CompletionSuggestions;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
@@ -52,9 +53,17 @@ final class MappingDescribeCommand extends AbstractEntityManagerCommand
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->setName('orm:mapping:describe')
|
||||
->addArgument('entityName', InputArgument::REQUIRED, 'Full or partial name of entity')
|
||||
->setDescription('Display information about mapped objects')
|
||||
->addOption('em', null, InputOption::VALUE_REQUIRED, 'Name of the entity manager to operate on')
|
||||
->addArgument('entityName', InputArgument::REQUIRED, 'Full or partial name of entity')
|
||||
->setDescription('Display information about mapped objects')
|
||||
->addOption('em', null, InputOption::VALUE_REQUIRED, 'Name of the entity manager to operate on')
|
||||
->addOption(
|
||||
'format',
|
||||
null,
|
||||
InputOption::VALUE_REQUIRED,
|
||||
'Output format (text, json)',
|
||||
MappingDescribeCommandFormat::TEXT->value,
|
||||
array_map(static fn (MappingDescribeCommandFormat $format) => $format->value, MappingDescribeCommandFormat::cases()),
|
||||
)
|
||||
->setHelp(<<<'EOT'
|
||||
The %command.full_name% command describes the metadata for the given full or partial entity class name.
|
||||
|
||||
@@ -63,6 +72,13 @@ The %command.full_name% command describes the metadata for the given full or par
|
||||
Or:
|
||||
|
||||
<info>%command.full_name%</info> MyEntity
|
||||
|
||||
To output the metadata in JSON format, use the <info>--format</info> option:
|
||||
<info>%command.full_name% My\Namespace\Entity\MyEntity --format=json</info>
|
||||
|
||||
To use a specific entity manager (e.g., for multi-DB projects), use the <info>--em</info> option:
|
||||
<info>%command.full_name% My\Namespace\Entity\MyEntity --em=my_custom_entity_manager</info>
|
||||
|
||||
EOT);
|
||||
}
|
||||
|
||||
@@ -70,9 +86,11 @@ EOT);
|
||||
{
|
||||
$ui = new SymfonyStyle($input, $output);
|
||||
|
||||
$format = MappingDescribeCommandFormat::from($input->getOption('format'));
|
||||
|
||||
$entityManager = $this->getEntityManager($input);
|
||||
|
||||
$this->displayEntity($input->getArgument('entityName'), $entityManager, $ui);
|
||||
$this->displayEntity($input->getArgument('entityName'), $entityManager, $ui, $format);
|
||||
|
||||
return 0;
|
||||
}
|
||||
@@ -89,6 +107,10 @@ EOT);
|
||||
|
||||
$suggestions->suggestValues(array_values($entities));
|
||||
}
|
||||
|
||||
if ($input->mustSuggestOptionValuesFor('format')) {
|
||||
$suggestions->suggestValues(array_map(static fn (MappingDescribeCommandFormat $format) => $format->value, MappingDescribeCommandFormat::cases()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -100,9 +122,47 @@ EOT);
|
||||
string $entityName,
|
||||
EntityManagerInterface $entityManager,
|
||||
SymfonyStyle $ui,
|
||||
MappingDescribeCommandFormat $format,
|
||||
): void {
|
||||
$metadata = $this->getClassMetadata($entityName, $entityManager);
|
||||
|
||||
if ($format === MappingDescribeCommandFormat::JSON) {
|
||||
$ui->text(json_encode(
|
||||
[
|
||||
'name' => $metadata->name,
|
||||
'rootEntityName' => $metadata->rootEntityName,
|
||||
'customGeneratorDefinition' => $this->formatValueAsJson($metadata->customGeneratorDefinition),
|
||||
'customRepositoryClassName' => $metadata->customRepositoryClassName,
|
||||
'isMappedSuperclass' => $metadata->isMappedSuperclass,
|
||||
'isEmbeddedClass' => $metadata->isEmbeddedClass,
|
||||
'parentClasses' => $metadata->parentClasses,
|
||||
'subClasses' => $metadata->subClasses,
|
||||
'embeddedClasses' => $metadata->embeddedClasses,
|
||||
'identifier' => $metadata->identifier,
|
||||
'inheritanceType' => $metadata->inheritanceType,
|
||||
'discriminatorColumn' => $this->formatValueAsJson($metadata->discriminatorColumn),
|
||||
'discriminatorValue' => $metadata->discriminatorValue,
|
||||
'discriminatorMap' => $metadata->discriminatorMap,
|
||||
'generatorType' => $metadata->generatorType,
|
||||
'table' => $this->formatValueAsJson($metadata->table),
|
||||
'isIdentifierComposite' => $metadata->isIdentifierComposite,
|
||||
'containsForeignIdentifier' => $metadata->containsForeignIdentifier,
|
||||
'containsEnumIdentifier' => $metadata->containsEnumIdentifier,
|
||||
'sequenceGeneratorDefinition' => $this->formatValueAsJson($metadata->sequenceGeneratorDefinition),
|
||||
'changeTrackingPolicy' => $metadata->changeTrackingPolicy,
|
||||
'isVersioned' => $metadata->isVersioned,
|
||||
'versionField' => $metadata->versionField,
|
||||
'isReadOnly' => $metadata->isReadOnly,
|
||||
'entityListeners' => $metadata->entityListeners,
|
||||
'associationMappings' => $this->formatMappingsAsJson($metadata->associationMappings),
|
||||
'fieldMappings' => $this->formatMappingsAsJson($metadata->fieldMappings),
|
||||
],
|
||||
JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR,
|
||||
));
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$ui->table(
|
||||
['Field', 'Value'],
|
||||
array_merge(
|
||||
@@ -240,6 +300,22 @@ EOT);
|
||||
throw new InvalidArgumentException(sprintf('Do not know how to format value "%s"', print_r($value, true)));
|
||||
}
|
||||
|
||||
/** @throws JsonException */
|
||||
private function formatValueAsJson(mixed $value): mixed
|
||||
{
|
||||
if (is_object($value)) {
|
||||
$value = (array) $value;
|
||||
}
|
||||
|
||||
if (is_array($value)) {
|
||||
foreach ($value as $k => $v) {
|
||||
$value[$k] = $this->formatValueAsJson($v);
|
||||
}
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the given label and value to the two column table output
|
||||
*
|
||||
@@ -281,6 +357,22 @@ EOT);
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, FieldMapping|AssociationMapping> $propertyMappings
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function formatMappingsAsJson(array $propertyMappings): array
|
||||
{
|
||||
$output = [];
|
||||
|
||||
foreach ($propertyMappings as $propertyName => $mapping) {
|
||||
$output[$propertyName] = $this->formatValueAsJson((array) $mapping);
|
||||
}
|
||||
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the entity listeners
|
||||
*
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\Console\Command;
|
||||
|
||||
enum MappingDescribeCommandFormat: string
|
||||
{
|
||||
case TEXT = 'text';
|
||||
case JSON = 'json';
|
||||
}
|
||||
@@ -0,0 +1,100 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
use Doctrine\ORM\Tools\CursorPagination\Exception\InvalidCursor;
|
||||
use JsonException;
|
||||
|
||||
use function base64_decode;
|
||||
use function base64_encode;
|
||||
use function json_decode;
|
||||
use function json_encode;
|
||||
use function rtrim;
|
||||
use function strtr;
|
||||
|
||||
use const JSON_THROW_ON_ERROR;
|
||||
|
||||
/**
|
||||
* Represents a cursor for cursor-based pagination.
|
||||
*
|
||||
* A cursor contains the parameters needed to fetch the next or previous page of results.
|
||||
*/
|
||||
final class Cursor
|
||||
{
|
||||
/** @param array<string, scalar> $parameters */
|
||||
public function __construct(
|
||||
private readonly array $parameters,
|
||||
private readonly bool $isNext = true,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* @return array<string, scalar>
|
||||
*/
|
||||
public function getParameters(): array
|
||||
{
|
||||
return $this->parameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the cursor is for navigating to the next page.
|
||||
*/
|
||||
public function isNext(): bool
|
||||
{
|
||||
return $this->isNext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the cursor is for navigating to the previous page.
|
||||
*/
|
||||
public function isPrevious(): bool
|
||||
{
|
||||
return ! $this->isNext;
|
||||
}
|
||||
|
||||
/** @return array<string, scalar> */
|
||||
public function toArray(): array
|
||||
{
|
||||
return [...$this->parameters, '_isNext' => $this->isNext];
|
||||
}
|
||||
|
||||
/**
|
||||
* Encodes the cursor to a URL-safe Base64 JSON string.
|
||||
*/
|
||||
public function encodeToString(): string
|
||||
{
|
||||
return rtrim(strtr(base64_encode((string) json_encode($this->toArray())), '+/', '-_'), '=');
|
||||
}
|
||||
|
||||
/**
|
||||
* Decodes a cursor from an encoded string.
|
||||
*
|
||||
* @see CursorWalker::buildCursorCondition() for the security model around cursor manipulation.
|
||||
*
|
||||
* @throws InvalidCursor If decoding fails.
|
||||
*/
|
||||
public static function fromEncodedString(string $encodedString): self
|
||||
{
|
||||
$decoded = base64_decode(strtr($encodedString, '-_', '+/'), strict: true);
|
||||
|
||||
if ($decoded === false) {
|
||||
throw new InvalidCursor($encodedString);
|
||||
}
|
||||
|
||||
try {
|
||||
$parameters = json_decode($decoded, associative: true, flags: JSON_THROW_ON_ERROR);
|
||||
} catch (JsonException $e) {
|
||||
throw new InvalidCursor($encodedString, $e);
|
||||
}
|
||||
|
||||
$isNext = $parameters['_isNext'] ?? true;
|
||||
|
||||
unset($parameters['_isNext']);
|
||||
|
||||
return new self($parameters, $isNext);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
/**
|
||||
* Represents a paginated item with its associated cursor.
|
||||
*
|
||||
* @template T
|
||||
*/
|
||||
final class CursorItem
|
||||
{
|
||||
/** @param T $value */
|
||||
public function __construct(
|
||||
private readonly mixed $value,
|
||||
private readonly Cursor $cursor,
|
||||
) {
|
||||
}
|
||||
|
||||
/** @return T */
|
||||
public function getValue(): mixed
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
public function getCursor(): Cursor
|
||||
{
|
||||
return $this->cursor;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
use Doctrine\ORM\Query\AST\PathExpression;
|
||||
|
||||
/** @internal */
|
||||
final class CursorOrderByItem
|
||||
{
|
||||
/** @param ClassMetadata<object>|null $metadata */
|
||||
public function __construct(
|
||||
public readonly PathExpression|string $expression,
|
||||
public readonly OrderDirection $direction,
|
||||
public readonly string $paramKey,
|
||||
public readonly ClassMetadata|null $metadata = null,
|
||||
) {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,280 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
use Countable;
|
||||
use Doctrine\Common\Collections\ArrayCollection;
|
||||
use Doctrine\Common\Collections\Collection;
|
||||
use Doctrine\DBAL\Exception;
|
||||
use Doctrine\ORM\Query;
|
||||
use Doctrine\ORM\Query\AST\PathExpression;
|
||||
use Doctrine\ORM\Query\QueryException;
|
||||
use Doctrine\ORM\QueryBuilder;
|
||||
use Doctrine\ORM\Utility\PersisterHelper;
|
||||
use IteratorAggregate;
|
||||
use LogicException;
|
||||
use Traversable;
|
||||
|
||||
use function array_map;
|
||||
use function array_reverse;
|
||||
|
||||
/**
|
||||
* The cursor paginator handles cursor-based pagination for DQL queries.
|
||||
*
|
||||
* @template T
|
||||
* @implements IteratorAggregate<mixed, T>
|
||||
*/
|
||||
final class CursorPaginator implements IteratorAggregate, Countable
|
||||
{
|
||||
private readonly Query $query;
|
||||
/** @var Collection<int, T>|null */
|
||||
private Collection|null $items = null;
|
||||
|
||||
/** @var list<CursorOrderByItem>|null */
|
||||
private array|null $orderByItems = null;
|
||||
|
||||
private bool $hasMore = false;
|
||||
private Cursor|null $cursor = null;
|
||||
|
||||
public function __construct(Query|QueryBuilder $query)
|
||||
{
|
||||
if ($query instanceof QueryBuilder) {
|
||||
$query = $query->getQuery();
|
||||
}
|
||||
|
||||
$this->query = $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the query.
|
||||
*/
|
||||
public function getQuery(): Query
|
||||
{
|
||||
return $this->query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Paginates the query with the given limit and optional cursor.
|
||||
*
|
||||
* @param string|null $cursor The encoded cursor string, null or empty string for the first page.
|
||||
* @param int $limit The maximum number of results to return.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function paginate(string|null $cursor, int $limit): self
|
||||
{
|
||||
$this->cursor = ! empty($cursor) ? Cursor::fromEncodedString($cursor) : null;
|
||||
$shouldReverse = $this->cursor?->isPrevious() ?? false;
|
||||
|
||||
$query = $this->cloneQuery($this->query);
|
||||
|
||||
$this->appendTreeWalker($query);
|
||||
|
||||
$query->setHint(CursorWalker::HINT_CURSOR_REVERSE, $shouldReverse);
|
||||
$query->setHint(CursorWalker::HINT_CURSOR_PARAMETERS, $this->cursor?->getParameters() ?? []);
|
||||
|
||||
$query->setMaxResults($limit + 1);
|
||||
|
||||
$this->items = new ArrayCollection($query->getResult());
|
||||
$this->hasMore = $this->items->count() > $limit;
|
||||
$this->items = new ArrayCollection($this->items->slice(0, $limit));
|
||||
|
||||
$this->orderByItems = $query->getHint(CursorWalker::HINT_CURSOR_ORDER_BY_ITEMS) ?: [];
|
||||
|
||||
if ($this->cursor !== null && $this->cursor->isPrevious()) {
|
||||
$this->items = new ArrayCollection(array_reverse($this->items->toArray(), true));
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
private function cloneQuery(Query $query): Query
|
||||
{
|
||||
$cloneQuery = clone $query;
|
||||
|
||||
$cloneQuery->setParameters(clone $query->getParameters());
|
||||
$cloneQuery->setCacheable(false);
|
||||
|
||||
foreach ($query->getHints() as $name => $value) {
|
||||
$cloneQuery->setHint($name, $value);
|
||||
}
|
||||
|
||||
return $cloneQuery;
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a custom tree walker to the tree walkers hint.
|
||||
*/
|
||||
private function appendTreeWalker(Query $query): void
|
||||
{
|
||||
$hints = $query->getHint(Query::HINT_CUSTOM_TREE_WALKERS);
|
||||
|
||||
if ($hints === false) {
|
||||
$hints = [];
|
||||
}
|
||||
|
||||
$hints[] = CursorWalker::class;
|
||||
$query->setHint(Query::HINT_CUSTOM_TREE_WALKERS, $hints);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*
|
||||
* @return Traversable<mixed, T>
|
||||
*/
|
||||
public function getIterator(): Traversable
|
||||
{
|
||||
return $this->items->getIterator();
|
||||
}
|
||||
|
||||
public function count(): int
|
||||
{
|
||||
return $this->items->count();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether there is a previous page.
|
||||
*/
|
||||
public function hasPreviousPage(): bool
|
||||
{
|
||||
return $this->cursor !== null && ($this->cursor->isNext() || $this->hasMore);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether there is a next page.
|
||||
*/
|
||||
public function hasNextPage(): bool
|
||||
{
|
||||
return $this->hasMore || ($this->cursor !== null && $this->cursor->isPrevious());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the cursor object for the next page.
|
||||
*
|
||||
* @throws LogicException If there is no next page. Check {@see hasNextPage()} first.
|
||||
*/
|
||||
public function getNextCursor(): Cursor
|
||||
{
|
||||
if ($this->items->isEmpty() || ! $this->hasNextPage()) {
|
||||
throw new LogicException('There is no next page. Call hasNextPage() before getNextCursor().');
|
||||
}
|
||||
|
||||
return $this->getCursorForItem($this->items->last());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the cursor object for the previous page.
|
||||
*
|
||||
* @throws LogicException If there is no previous page. Check {@see hasPreviousPage()} first.
|
||||
*/
|
||||
public function getPreviousCursor(): Cursor
|
||||
{
|
||||
if ($this->items->isEmpty() || ! $this->hasPreviousPage()) {
|
||||
throw new LogicException('There is no previous page. Call hasPreviousPage() before getPreviousCursor().');
|
||||
}
|
||||
|
||||
return $this->getCursorForItem($this->items->first(), false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the encoded cursor string for the next page.
|
||||
*
|
||||
* @throws LogicException If there is no next page. Check {@see hasNextPage()} first.
|
||||
*/
|
||||
public function getNextCursorAsString(): string
|
||||
{
|
||||
return $this->getNextCursor()->encodeToString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the encoded cursor string for the previous page.
|
||||
*
|
||||
* @throws LogicException If there is no previous page. Check {@see hasPreviousPage()} first.
|
||||
*/
|
||||
public function getPreviousCursorAsString(): string
|
||||
{
|
||||
return $this->getPreviousCursor()->encodeToString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the cursor for a given item.
|
||||
*
|
||||
* @param mixed $item The item to create a cursor for.
|
||||
* @param bool $isNext Whether the cursor is for the next page.
|
||||
*
|
||||
* @throws Exception
|
||||
* @throws QueryException
|
||||
*/
|
||||
public function getCursorForItem(mixed $item, bool $isNext = true): Cursor
|
||||
{
|
||||
return new Cursor($this->getParametersForItem($item), $isNext);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns items wrapped with their associated cursors.
|
||||
*
|
||||
* @return array<int, CursorItem<T>>
|
||||
*
|
||||
* @throws Exception
|
||||
* @throws QueryException
|
||||
*/
|
||||
public function getItems(): array
|
||||
{
|
||||
return array_map(
|
||||
fn (mixed $item) => new CursorItem($item, $this->getCursorForItem($item)),
|
||||
$this->items->toArray(),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the raw entity values.
|
||||
*
|
||||
* @return list<T>
|
||||
*/
|
||||
public function getValues(): array
|
||||
{
|
||||
return $this->items->getValues();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether pagination is needed.
|
||||
*/
|
||||
public function hasToPaginate(): bool
|
||||
{
|
||||
return $this->hasPreviousPage() || $this->hasNextPage();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, mixed>
|
||||
*
|
||||
* @throws Query\QueryException
|
||||
* @throws Exception
|
||||
*/
|
||||
private function getParametersForItem(mixed $item): array
|
||||
{
|
||||
$em = $this->query->getEntityManager();
|
||||
$connection = $em->getConnection();
|
||||
$metadata = $em->getMetadataFactory()->hasMetadataFor($item::class)
|
||||
? $em->getClassMetadata($item::class)
|
||||
: null;
|
||||
|
||||
$result = [];
|
||||
|
||||
foreach ($this->orderByItems as $orderByItem) {
|
||||
if (! $orderByItem->expression instanceof PathExpression) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$fieldName = $orderByItem->expression->field;
|
||||
$orderMetadata = $orderByItem->metadata ?? $metadata;
|
||||
$value = $metadata?->getFieldValue($item, $fieldName) ?? $item->$fieldName;
|
||||
$type = PersisterHelper::getTypeOfField($fieldName, $orderMetadata, $em)[0];
|
||||
|
||||
$result[$orderByItem->paramKey] = $connection->convertToDatabaseValue($value, $type);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,200 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
use Doctrine\ORM\Query\AST\ComparisonExpression;
|
||||
use Doctrine\ORM\Query\AST\ConditionalExpression;
|
||||
use Doctrine\ORM\Query\AST\ConditionalPrimary;
|
||||
use Doctrine\ORM\Query\AST\ConditionalTerm;
|
||||
use Doctrine\ORM\Query\AST\InputParameter;
|
||||
use Doctrine\ORM\Query\AST\OrderByClause;
|
||||
use Doctrine\ORM\Query\AST\OrderByItem;
|
||||
use Doctrine\ORM\Query\AST\PathExpression;
|
||||
use Doctrine\ORM\Query\AST\SelectStatement;
|
||||
use Doctrine\ORM\Query\AST\WhereClause;
|
||||
use Doctrine\ORM\Query\QueryException;
|
||||
use Doctrine\ORM\Query\TreeWalkerAdapter;
|
||||
use LogicException;
|
||||
|
||||
use function count;
|
||||
use function str_replace;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*
|
||||
* TreeWalker for cursor-based pagination.
|
||||
*
|
||||
* Responsibilities:
|
||||
* - Extract ORDER BY columns from AST
|
||||
* - Inject WHERE conditions for cursor navigation
|
||||
* - Reverse ORDER BY direction for previous page navigation
|
||||
*/
|
||||
class CursorWalker extends TreeWalkerAdapter
|
||||
{
|
||||
public const HINT_CURSOR_PARAMETERS = 'doctrine.cursor.parameters';
|
||||
public const HINT_CURSOR_REVERSE = 'doctrine.cursor.reverse';
|
||||
public const HINT_CURSOR_ORDER_BY_ITEMS = 'doctrine.cursor.order_by_items';
|
||||
|
||||
public function walkSelectStatement(SelectStatement $selectStatement): void
|
||||
{
|
||||
$query = $this->_getQuery();
|
||||
$shouldReverse = $query->getHint(self::HINT_CURSOR_REVERSE) === true;
|
||||
$cursorParameters = $query->getHint(self::HINT_CURSOR_PARAMETERS);
|
||||
|
||||
if (! isset($selectStatement->orderByClause)) {
|
||||
throw new LogicException('No ORDER BY clause found. Cursor pagination requires a deterministic sort order.');
|
||||
}
|
||||
|
||||
$orderByItems = [];
|
||||
$newOrderByItems = [];
|
||||
|
||||
foreach ($selectStatement->orderByClause->orderByItems as $orderByItem) {
|
||||
$direction = OrderDirection::fromOrderByItem($orderByItem, $shouldReverse);
|
||||
|
||||
$paramKey = $this->getParameterKey($orderByItem->expression);
|
||||
$metadata = $orderByItem->expression instanceof PathExpression
|
||||
? $this->getMetadataForDqlAlias($orderByItem->expression->identificationVariable)
|
||||
: null;
|
||||
|
||||
$orderByItems[] = new CursorOrderByItem($orderByItem->expression, $direction, $paramKey, $metadata);
|
||||
|
||||
$newItem = new OrderByItem($orderByItem->expression);
|
||||
$newItem->type = $direction->value;
|
||||
$newOrderByItems[] = $newItem;
|
||||
}
|
||||
|
||||
$selectStatement->orderByClause = new OrderByClause($newOrderByItems);
|
||||
|
||||
$query->setHint(self::HINT_CURSOR_ORDER_BY_ITEMS, $orderByItems);
|
||||
|
||||
if (empty($cursorParameters)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$condition = $this->buildCursorCondition($orderByItems, $cursorParameters);
|
||||
|
||||
if ($condition === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$conditionalPrimary = new ConditionalPrimary();
|
||||
$conditionalPrimary->conditionalExpression = $condition;
|
||||
|
||||
if ($selectStatement->whereClause !== null) {
|
||||
if ($selectStatement->whereClause->conditionalExpression instanceof ConditionalTerm) {
|
||||
$selectStatement->whereClause->conditionalExpression->conditionalFactors[] = $conditionalPrimary;
|
||||
} elseif ($selectStatement->whereClause->conditionalExpression instanceof ConditionalPrimary) {
|
||||
$selectStatement->whereClause->conditionalExpression = new ConditionalExpression(
|
||||
[
|
||||
new ConditionalTerm(
|
||||
[
|
||||
$selectStatement->whereClause->conditionalExpression,
|
||||
$conditionalPrimary,
|
||||
],
|
||||
),
|
||||
],
|
||||
);
|
||||
} else {
|
||||
$existingPrimary = new ConditionalPrimary();
|
||||
$existingPrimary->conditionalExpression = $selectStatement->whereClause->conditionalExpression;
|
||||
$selectStatement->whereClause->conditionalExpression = new ConditionalTerm(
|
||||
[
|
||||
$existingPrimary,
|
||||
$conditionalPrimary,
|
||||
],
|
||||
);
|
||||
}
|
||||
} else {
|
||||
$selectStatement->whereClause = new WhereClause(
|
||||
new ConditionalExpression(
|
||||
[new ConditionalTerm([$conditionalPrimary])],
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively builds a cursor condition:
|
||||
* (col1 > :val1) OR (col1 = :val1 AND col2 > :val2) OR ...
|
||||
*
|
||||
* @param list<CursorOrderByItem> $orderByItems
|
||||
* @param array<string, mixed> $cursorParameters
|
||||
*
|
||||
* @throws QueryException
|
||||
*/
|
||||
private function buildCursorCondition(array $orderByItems, array $cursorParameters, int $index = 0): ConditionalExpression|null
|
||||
{
|
||||
if (! isset($orderByItems[$index])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$orderByItem = $orderByItems[$index];
|
||||
$expression = $orderByItem->expression;
|
||||
$direction = $orderByItem->direction;
|
||||
$paramKey = $orderByItem->paramKey;
|
||||
|
||||
$operator = $direction->operator();
|
||||
|
||||
$paramName = str_replace('.', '_', $paramKey) . '_' . $index;
|
||||
$paramValue = $cursorParameters[$paramKey] ?? null;
|
||||
|
||||
// Security note: $paramKey is derived from the DQL ORDER BY AST, not from the
|
||||
// cursor payload. A tampered cursor can only influence the *values* used as pivot
|
||||
// points, not the columns being filtered. All values are bound via setParameter(),
|
||||
// so SQL injection is not possible. The worst a user can do is navigate to an
|
||||
// arbitrary position in the result set, while remaining bound by the original
|
||||
// query's WHERE constraints.
|
||||
$this->_getQuery()->setParameter($paramName, $paramValue);
|
||||
|
||||
$comparisonExpr = new ComparisonExpression(
|
||||
$expression,
|
||||
$operator,
|
||||
new InputParameter(':' . $paramName),
|
||||
);
|
||||
|
||||
$comparisonPrimary = new ConditionalPrimary();
|
||||
$comparisonPrimary->simpleConditionalExpression = $comparisonExpr;
|
||||
|
||||
if ($index === count($orderByItems) - 1) {
|
||||
return new ConditionalExpression([new ConditionalTerm([$comparisonPrimary])]);
|
||||
}
|
||||
|
||||
$nextCondition = $this->buildCursorCondition($orderByItems, $cursorParameters, $index + 1);
|
||||
|
||||
$equalityExpr = new ComparisonExpression(
|
||||
$expression,
|
||||
'=',
|
||||
new InputParameter(':' . $paramName),
|
||||
);
|
||||
|
||||
$equalityPrimary = new ConditionalPrimary();
|
||||
$equalityPrimary->simpleConditionalExpression = $equalityExpr;
|
||||
|
||||
$nextPrimary = new ConditionalPrimary();
|
||||
$nextPrimary->conditionalExpression = $nextCondition;
|
||||
|
||||
$andPrimary = new ConditionalPrimary();
|
||||
$andPrimary->conditionalExpression = new ConditionalExpression([
|
||||
new ConditionalTerm([$equalityPrimary, $nextPrimary]),
|
||||
]);
|
||||
|
||||
return new ConditionalExpression([
|
||||
new ConditionalTerm([$comparisonPrimary]),
|
||||
new ConditionalTerm([$andPrimary]),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the parameter key for the given expression.
|
||||
*/
|
||||
private function getParameterKey(mixed $expression): string
|
||||
{
|
||||
if ($expression instanceof PathExpression) {
|
||||
return $expression->identificationVariable . '.' . $expression->field;
|
||||
}
|
||||
|
||||
return (string) $expression;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination\Exception;
|
||||
|
||||
use InvalidArgumentException;
|
||||
use Throwable;
|
||||
|
||||
use function sprintf;
|
||||
|
||||
final class InvalidCursor extends InvalidArgumentException
|
||||
{
|
||||
public function __construct(string $cursor, Throwable|null $previous = null)
|
||||
{
|
||||
parent::__construct(
|
||||
sprintf(
|
||||
'The cursor "%s" could not be decoded.',
|
||||
$cursor,
|
||||
),
|
||||
previous: $previous,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\ORM\Tools\CursorPagination;
|
||||
|
||||
use Doctrine\ORM\Query\AST\OrderByItem;
|
||||
|
||||
/** @internal */
|
||||
enum OrderDirection: string
|
||||
{
|
||||
case Ascending = 'ASC';
|
||||
case Descending = 'DESC';
|
||||
|
||||
public static function fromOrderByItem(OrderByItem $item, bool $reverse = false): self
|
||||
{
|
||||
$direction = $item->isAsc() ? self::Ascending : self::Descending;
|
||||
|
||||
return $reverse ? $direction->reversed() : $direction;
|
||||
}
|
||||
|
||||
public function operator(): string
|
||||
{
|
||||
return match ($this) {
|
||||
self::Ascending => '>',
|
||||
self::Descending => '<',
|
||||
};
|
||||
}
|
||||
|
||||
public function reversed(): self
|
||||
{
|
||||
return match ($this) {
|
||||
self::Ascending => self::Descending,
|
||||
self::Descending => self::Ascending,
|
||||
};
|
||||
}
|
||||
}
|
||||
+75
-12
@@ -9,6 +9,10 @@ use Doctrine\DBAL\Platforms\AbstractPlatform;
|
||||
use Doctrine\DBAL\Schema\AbstractAsset;
|
||||
use Doctrine\DBAL\Schema\AbstractSchemaManager;
|
||||
use Doctrine\DBAL\Schema\ComparatorConfig;
|
||||
use Doctrine\DBAL\Schema\DefaultExpression;
|
||||
use Doctrine\DBAL\Schema\DefaultExpression\CurrentDate;
|
||||
use Doctrine\DBAL\Schema\DefaultExpression\CurrentTime;
|
||||
use Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp;
|
||||
use Doctrine\DBAL\Schema\ForeignKeyConstraintEditor;
|
||||
use Doctrine\DBAL\Schema\Index;
|
||||
use Doctrine\DBAL\Schema\Index\IndexedColumn;
|
||||
@@ -18,6 +22,8 @@ use Doctrine\DBAL\Schema\NamedObject;
|
||||
use Doctrine\DBAL\Schema\PrimaryKeyConstraint;
|
||||
use Doctrine\DBAL\Schema\Schema;
|
||||
use Doctrine\DBAL\Schema\Table;
|
||||
use Doctrine\DBAL\Types\Types;
|
||||
use Doctrine\Deprecations\Deprecation;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\Mapping\AssociationMapping;
|
||||
use Doctrine\ORM\Mapping\ClassMetadata;
|
||||
@@ -46,6 +52,7 @@ use function count;
|
||||
use function current;
|
||||
use function implode;
|
||||
use function in_array;
|
||||
use function interface_exists;
|
||||
use function is_numeric;
|
||||
use function method_exists;
|
||||
use function preg_match;
|
||||
@@ -382,21 +389,17 @@ class SchemaTool
|
||||
}
|
||||
}
|
||||
|
||||
if ($eventManager->hasListeners(ToolEvents::postGenerateSchemaTable)) {
|
||||
$eventManager->dispatchEvent(
|
||||
ToolEvents::postGenerateSchemaTable,
|
||||
new GenerateSchemaTableEventArgs($class, $schema, $table),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if ($eventManager->hasListeners(ToolEvents::postGenerateSchema)) {
|
||||
$eventManager->dispatchEvent(
|
||||
ToolEvents::postGenerateSchema,
|
||||
new GenerateSchemaEventArgs($this->em, $schema),
|
||||
ToolEvents::postGenerateSchemaTable,
|
||||
new GenerateSchemaTableEventArgs($class, $schema, $table),
|
||||
);
|
||||
}
|
||||
|
||||
$eventManager->dispatchEvent(
|
||||
ToolEvents::postGenerateSchema,
|
||||
new GenerateSchemaEventArgs($this->em, $schema),
|
||||
);
|
||||
|
||||
return $schema;
|
||||
}
|
||||
|
||||
@@ -478,7 +481,9 @@ class SchemaTool
|
||||
$options['scale'] = $mapping->scale;
|
||||
}
|
||||
|
||||
/** @phpstan-ignore property.deprecated */
|
||||
if (isset($mapping->default)) {
|
||||
/** @phpstan-ignore property.deprecated */
|
||||
$options['default'] = $mapping->default;
|
||||
}
|
||||
|
||||
@@ -489,6 +494,64 @@ class SchemaTool
|
||||
// the 'default' option can be overwritten here
|
||||
$options = $this->gatherColumnOptions($mapping) + $options;
|
||||
|
||||
if (isset($options['default']) && interface_exists(DefaultExpression::class)) {
|
||||
if (
|
||||
in_array($mapping->type, [
|
||||
Types::DATETIME_MUTABLE,
|
||||
Types::DATETIME_IMMUTABLE,
|
||||
Types::DATETIMETZ_MUTABLE,
|
||||
Types::DATETIMETZ_IMMUTABLE,
|
||||
], true)
|
||||
&& $options['default'] === $this->platform->getCurrentTimestampSQL()
|
||||
) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/issues/12252',
|
||||
<<<'DEPRECATION'
|
||||
Using "%s" as a default value for datetime fields is deprecated and
|
||||
will not be supported in Doctrine ORM 4.0.
|
||||
Pass a `Doctrine\DBAL\Schema\DefaultExpression\CurrentTimestamp` instance instead.
|
||||
DEPRECATION,
|
||||
$this->platform->getCurrentTimestampSQL(),
|
||||
);
|
||||
$options['default'] = new CurrentTimestamp();
|
||||
}
|
||||
|
||||
if (
|
||||
in_array($mapping->type, [Types::TIME_MUTABLE, Types::TIME_IMMUTABLE], true)
|
||||
&& $options['default'] === $this->platform->getCurrentTimeSQL()
|
||||
) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/issues/12252',
|
||||
<<<'DEPRECATION'
|
||||
Using "%s" as a default value for time fields is deprecated and
|
||||
will not be supported in Doctrine ORM 4.0.
|
||||
Pass a `Doctrine\DBAL\Schema\DefaultExpression\CurrentTime` instance instead.
|
||||
DEPRECATION,
|
||||
$this->platform->getCurrentTimeSQL(),
|
||||
);
|
||||
$options['default'] = new CurrentTime();
|
||||
}
|
||||
|
||||
if (
|
||||
in_array($mapping->type, [Types::DATE_MUTABLE, Types::DATE_IMMUTABLE], true)
|
||||
&& $options['default'] === $this->platform->getCurrentDateSQL()
|
||||
) {
|
||||
Deprecation::trigger(
|
||||
'doctrine/orm',
|
||||
'https://github.com/doctrine/orm/issues/12252',
|
||||
<<<'DEPRECATION'
|
||||
Using "%s" as a default value for date fields is deprecated and
|
||||
will not be supported in Doctrine ORM 4.0.
|
||||
Pass a `Doctrine\DBAL\Schema\DefaultExpression\CurrentDate` instance instead.
|
||||
DEPRECATION,
|
||||
$this->platform->getCurrentDateSQL(),
|
||||
);
|
||||
$options['default'] = new CurrentDate();
|
||||
}
|
||||
}
|
||||
|
||||
if ($class->isIdGeneratorIdentity() && $class->getIdentifierFieldNames() === [$mapping->fieldName]) {
|
||||
$options['autoincrement'] = true;
|
||||
}
|
||||
@@ -1009,7 +1072,7 @@ class SchemaTool
|
||||
{
|
||||
return $asset instanceof NamedObject
|
||||
? $asset->getObjectName()->toString()
|
||||
// DBAL < 4.4
|
||||
// @phpstan-ignore method.deprecated (DBAL < 4.4)
|
||||
: $asset->getName();
|
||||
}
|
||||
}
|
||||
|
||||
+26
-24
@@ -8,7 +8,7 @@ use BackedEnum;
|
||||
use DateTimeInterface;
|
||||
use Doctrine\Common\Collections\ArrayCollection;
|
||||
use Doctrine\Common\Collections\Collection;
|
||||
use Doctrine\Common\EventManager;
|
||||
use Doctrine\Common\EventDispatcher;
|
||||
use Doctrine\DBAL;
|
||||
use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
|
||||
use Doctrine\DBAL\LockMode;
|
||||
@@ -62,6 +62,7 @@ use function array_map;
|
||||
use function array_sum;
|
||||
use function array_values;
|
||||
use function assert;
|
||||
use function count;
|
||||
use function current;
|
||||
use function get_debug_type;
|
||||
use function implode;
|
||||
@@ -260,9 +261,9 @@ class UnitOfWork implements PropertyChangedListener
|
||||
private array $collectionPersisters = [];
|
||||
|
||||
/**
|
||||
* The EventManager used for dispatching events.
|
||||
* The EventDispatcher used for dispatching events.
|
||||
*/
|
||||
private readonly EventManager $evm;
|
||||
private readonly EventDispatcher $eventDispatcher;
|
||||
|
||||
/**
|
||||
* The ListenersInvoker used for dispatching events.
|
||||
@@ -313,7 +314,7 @@ class UnitOfWork implements PropertyChangedListener
|
||||
public function __construct(
|
||||
private readonly EntityManagerInterface $em,
|
||||
) {
|
||||
$this->evm = $em->getEventManager();
|
||||
$this->eventDispatcher = $em->getEventManager();
|
||||
$this->listenersInvoker = new ListenersInvoker($em);
|
||||
$this->hasCache = $em->getConfiguration()->isSecondLevelCacheEnabled();
|
||||
$this->identifierFlattener = new IdentifierFlattener($this, $em->getMetadataFactory());
|
||||
@@ -343,10 +344,7 @@ class UnitOfWork implements PropertyChangedListener
|
||||
$connection->ensureConnectedToPrimary();
|
||||
}
|
||||
|
||||
// Raise preFlush
|
||||
if ($this->evm->hasListeners(Events::preFlush)) {
|
||||
$this->evm->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
|
||||
}
|
||||
$this->dispatchPreFlushEvent();
|
||||
|
||||
// Compute changes done since last commit.
|
||||
$this->computeChangeSets();
|
||||
@@ -377,8 +375,7 @@ class UnitOfWork implements PropertyChangedListener
|
||||
|
||||
$this->dispatchOnFlushEvent();
|
||||
|
||||
$conn = $this->em->getConnection();
|
||||
$conn->beginTransaction();
|
||||
$connection->beginTransaction();
|
||||
|
||||
$successful = false;
|
||||
|
||||
@@ -429,7 +426,7 @@ class UnitOfWork implements PropertyChangedListener
|
||||
|
||||
$commitFailed = false;
|
||||
try {
|
||||
if ($conn->commit() === false) {
|
||||
if ($connection->commit() === false) {
|
||||
$commitFailed = true;
|
||||
}
|
||||
} catch (DBAL\Exception $e) {
|
||||
@@ -445,8 +442,8 @@ class UnitOfWork implements PropertyChangedListener
|
||||
if (! $successful) {
|
||||
$this->em->close();
|
||||
|
||||
if ($conn->isTransactionActive()) {
|
||||
$conn->rollBack();
|
||||
if ($connection->isTransactionActive()) {
|
||||
$connection->rollBack();
|
||||
}
|
||||
|
||||
$this->afterTransactionRolledBack();
|
||||
@@ -2298,9 +2295,7 @@ class UnitOfWork implements PropertyChangedListener
|
||||
$this->eagerLoadingCollections =
|
||||
$this->orphanRemovals = [];
|
||||
|
||||
if ($this->evm->hasListeners(Events::onClear)) {
|
||||
$this->evm->dispatchEvent(Events::onClear, new OnClearEventArgs($this->em));
|
||||
}
|
||||
$this->eventDispatcher->dispatchEvent(Events::onClear, new OnClearEventArgs($this->em));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -2594,8 +2589,14 @@ class UnitOfWork implements PropertyChangedListener
|
||||
$reflField->setValue($entity, $pColl);
|
||||
|
||||
if ($hints['fetchMode'][$class->name][$field] === ClassMetadata::FETCH_EAGER) {
|
||||
$isIteration = isset($hints[Query::HINT_INTERNAL_ITERATION]) && $hints[Query::HINT_INTERNAL_ITERATION];
|
||||
if (! $isIteration && $assoc->isOneToMany() && ! $targetClass->isIdentifierComposite && ! $assoc->isIndexed()) {
|
||||
if (
|
||||
$assoc->isOneToMany()
|
||||
// is iteration
|
||||
&& ! (isset($hints[Query::HINT_INTERNAL_ITERATION]) && $hints[Query::HINT_INTERNAL_ITERATION])
|
||||
// is foreign key composite
|
||||
&& ! ($targetClass->hasAssociation($assoc->mappedBy) && count($targetClass->getAssociationMapping($assoc->mappedBy)->joinColumns) > 1)
|
||||
&& ! $assoc->isIndexed()
|
||||
) {
|
||||
$this->scheduleCollectionForBatchLoading($pColl, $class);
|
||||
} else {
|
||||
$this->loadCollection($pColl);
|
||||
@@ -3140,18 +3141,19 @@ class UnitOfWork implements PropertyChangedListener
|
||||
}
|
||||
}
|
||||
|
||||
private function dispatchPreFlushEvent(): void
|
||||
{
|
||||
$this->eventDispatcher->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
|
||||
}
|
||||
|
||||
private function dispatchOnFlushEvent(): void
|
||||
{
|
||||
if ($this->evm->hasListeners(Events::onFlush)) {
|
||||
$this->evm->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
|
||||
}
|
||||
$this->eventDispatcher->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
|
||||
}
|
||||
|
||||
private function dispatchPostFlushEvent(): void
|
||||
{
|
||||
if ($this->evm->hasListeners(Events::postFlush)) {
|
||||
$this->evm->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
|
||||
}
|
||||
$this->eventDispatcher->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -13,14 +13,13 @@ use Doctrine\DBAL\Result;
|
||||
use Doctrine\ORM\Configuration;
|
||||
use Doctrine\ORM\EntityManager;
|
||||
use Doctrine\ORM\EntityManagerInterface;
|
||||
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
|
||||
use Doctrine\ORM\Proxy\ProxyFactory;
|
||||
use Doctrine\ORM\Tools\SchemaTool;
|
||||
use Doctrine\Tests\Mocks\ArrayResultFactory;
|
||||
use Doctrine\Tests\Mocks\AttributeDriverFactory;
|
||||
use Doctrine\Tests\TestUtil;
|
||||
|
||||
use function array_map;
|
||||
use function realpath;
|
||||
|
||||
final class EntityManagerFactory
|
||||
{
|
||||
@@ -30,9 +29,9 @@ final class EntityManagerFactory
|
||||
|
||||
TestUtil::configureProxies($config);
|
||||
$config->setAutoGenerateProxyClasses(ProxyFactory::AUTOGENERATE_EVAL);
|
||||
$config->setMetadataDriverImpl(new AttributeDriver([
|
||||
realpath(__DIR__ . '/Models/Cache'),
|
||||
realpath(__DIR__ . '/Models/GeoNames'),
|
||||
$config->setMetadataDriverImpl(AttributeDriverFactory::createAttributeDriver([
|
||||
__DIR__ . '/../Tests/Models/Cache',
|
||||
__DIR__ . '/../Tests/Models/GeoNames',
|
||||
]));
|
||||
|
||||
$entityManager = new EntityManager(
|
||||
@@ -55,10 +54,10 @@ final class EntityManagerFactory
|
||||
|
||||
TestUtil::configureProxies($config);
|
||||
$config->setAutoGenerateProxyClasses(ProxyFactory::AUTOGENERATE_EVAL);
|
||||
$config->setMetadataDriverImpl(new AttributeDriver([
|
||||
realpath(__DIR__ . '/Models/Cache'),
|
||||
realpath(__DIR__ . '/Models/Generic'),
|
||||
realpath(__DIR__ . '/Models/GeoNames'),
|
||||
$config->setMetadataDriverImpl(AttributeDriverFactory::createAttributeDriver([
|
||||
__DIR__ . '/../Tests/Models/Cache',
|
||||
__DIR__ . '/../Tests/Models/Generic',
|
||||
__DIR__ . '/../Tests/Models/GeoNames',
|
||||
]));
|
||||
|
||||
// A connection that doesn't really do anything
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Doctrine\Tests\Mocks;
|
||||
|
||||
use Doctrine\ORM\Mapping\Driver\AttributeDriver;
|
||||
use Doctrine\Persistence\Mapping\Driver\ClassLocator;
|
||||
use Doctrine\Persistence\Mapping\Driver\FileClassLocator;
|
||||
|
||||
use function interface_exists;
|
||||
|
||||
final class AttributeDriverFactory
|
||||
{
|
||||
/** @param list<string> $paths */
|
||||
public static function createAttributeDriver(array $paths = []): AttributeDriver
|
||||
{
|
||||
if (! self::isClassLocatorSupported()) {
|
||||
// Persistence < 4.1
|
||||
return new AttributeDriver($paths);
|
||||
}
|
||||
|
||||
// Persistence >= 4.1
|
||||
$classLocator = FileClassLocator::createFromDirectories($paths);
|
||||
|
||||
return new AttributeDriver($classLocator);
|
||||
}
|
||||
|
||||
/** Supported since doctrine/persistence >= 4.1 */
|
||||
public static function isClassLocatorSupported(): bool
|
||||
{
|
||||
return interface_exists(ClassLocator::class);
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user