Merge remote-tracking branch 'origin/3.2.x' into 3.3.x

.github/workflows/coding-standards.yml

@@ -24,4 +24,4 @@ on:
 
 jobs:
  coding-standards:
- uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.0.1"
+ uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.1.0"

.github/workflows/documentation.yml

@@ -5,45 +5,16 @@ on:
  branches:
  - "*.x"
  paths:
- - .github/workflows/documentation.yml
- - docs/**
+ - ".github/workflows/documentation.yml"
+ - "docs/**"
  push:
  branches:
  - "*.x"
  paths:
- - .github/workflows/documentation.yml
- - docs/**
+ - ".github/workflows/documentation.yml"
+ - "docs/**"
 
 jobs:
- validate-with-guides:
- name: "Validate documentation with phpDocumentor/guides"
- runs-on: "ubuntu-22.04"
-
- steps:
- - name: "Checkout code"
- uses: "actions/checkout@v4"
-
- - name: "Install PHP"
- uses: "shivammathur/setup-php@v2"
- with:
- coverage: "none"
- php-version: "8.3"
-
- - name: "Remove existing composer file"
- run: "rm composer.json"
-
- - name: "Require phpdocumentor/guides-cli"
- run: "composer require --dev phpdocumentor/guides-cli --no-update"
-
- - name: "Install dependencies with Composer"
- uses: "ramsey/composer-install@v3"
- with:
- dependency-versions: "highest"
-
- - name: "Add orphan metadata where needed"
- run: |
- printf '%s\n\n%s\n' ":orphan:" "$(cat docs/en/sidebar.rst)" > docs/en/sidebar.rst
- printf '%s\n\n%s\n' ":orphan:" "$(cat docs/en/reference/installation.rst)" > docs/en/reference/installation.rst
-
- - name: "Run guides-cli"
- run: "vendor/bin/guides -vvv --no-progress docs/en 2>&1 | grep -v 'No template found for rendering directive' | ( ! grep WARNING )"
+ documentation:
+ name: "Documentation"
+ uses: "doctrine/.github/.github/workflows/documentation.yml@5.1.0"

.github/workflows/release-on-milestone-closed.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
  release:
- uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@5.0.1"
+ uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@5.1.0"
  secrets:
  GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
  GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}

composer.json

@@ -38,7 +38,8 @@
  "require-dev": {
  "doctrine/coding-standard": "^12.0",
  "phpbench/phpbench": "^1.0",
- "phpstan/phpstan": "1.11.1",
+ "phpdocumentor/guides-cli": "^1.4",
+ "phpstan/phpstan": "1.12.0",
  "phpunit/phpunit": "^10.4.0",
  "psr/log": "^1 || ^2 || ^3",
  "squizlabs/php_codesniffer": "3.7.2",

docs/en/reference/attributes-reference.rst

@@ -15,7 +15,7 @@ Index
 - :ref:`#[AttributeOverride] <attrref_attributeoverride>`
 - :ref:`#[Column] <attrref_column>`
 - :ref:`#[Cache] <attrref_cache>`
-- :ref:`#[ChangeTrackingPolicy <attrref_changetrackingpolicy>`
+- :ref:`#[ChangeTrackingPolicy] <attrref_changetrackingpolicy>`
 - :ref:`#[CustomIdGenerator] <attrref_customidgenerator>`
 - :ref:`#[DiscriminatorColumn] <attrref_discriminatorcolumn>`
 - :ref:`#[DiscriminatorMap] <attrref_discriminatormap>`

docs/en/reference/installation.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 Installation
 ============
 

docs/en/sidebar.rst

@@ -1,81 +1,74 @@
-.. toc::
+:orphan:
 
- .. tocheader:: Tutorials
+.. toctree::
+ :caption: Tutorials
+ :depth: 3
 
- .. toctree::
- :depth: 3
+ tutorials/getting-started
+ tutorials/getting-started-database
+ tutorials/getting-started-models
+ tutorials/working-with-indexed-associations
+ tutorials/extra-lazy-associations
+ tutorials/composite-primary-keys
+ tutorials/ordered-associations
+ tutorials/override-field-association-mappings-in-subclasses
+ tutorials/pagination
+ tutorials/embeddables
 
- tutorials/getting-started
- tutorials/getting-started-database
- tutorials/getting-started-models
- tutorials/working-with-indexed-associations
- tutorials/extra-lazy-associations
- tutorials/composite-primary-keys
- tutorials/ordered-associations
- tutorials/override-field-association-mappings-in-subclasses
- tutorials/pagination
- tutorials/embeddables
+.. toctree::
+ :caption: Reference
+ :depth: 3
 
-.. toc::
+ reference/architecture
+ reference/configuration
+ reference/faq
+ reference/basic-mapping
+ reference/association-mapping
+ reference/inheritance-mapping
+ reference/working-with-objects
+ reference/working-with-associations
+ reference/typedfieldmapper
+ reference/events
+ reference/unitofwork
+ reference/unitofwork-associations
+ reference/transactions-and-concurrency
+ reference/batch-processing
+ reference/dql-doctrine-query-language
+ reference/query-builder
+ reference/native-sql
+ reference/change-tracking-policies
+ reference/partial-hydration
+ reference/attributes-reference
+ reference/xml-mapping
+ reference/php-mapping
+ reference/caching
+ reference/improving-performance
+ reference/tools
+ reference/metadata-drivers
+ reference/best-practices
+ reference/limitations-and-known-issues
+ tutorials/pagination
+ reference/filters
+ reference/namingstrategy
+ reference/advanced-configuration
+ reference/second-level-cache
+ reference/security
 
- .. tocheader:: Reference
+.. toctree::
+ :caption: Cookbook
+ :depth: 3
 
- .. toctree::
- :depth: 3
-
- reference/architecture
- reference/configuration
- reference/faq
- reference/basic-mapping
- reference/association-mapping
- reference/inheritance-mapping
- reference/working-with-objects
- reference/working-with-associations
- reference/typedfieldmapper
- reference/events
- reference/unitofwork
- reference/unitofwork-associations
- reference/transactions-and-concurrency
- reference/batch-processing
- reference/dql-doctrine-query-language
- reference/query-builder
- reference/native-sql
- reference/change-tracking-policies
- reference/partial-hydration
- reference/attributes-reference
- reference/xml-mapping
- reference/php-mapping
- reference/caching
- reference/improving-performance
- reference/tools
- reference/metadata-drivers
- reference/best-practices
- reference/limitations-and-known-issues
- tutorials/pagination
- reference/filters
- reference/namingstrategy
- reference/advanced-configuration
- reference/second-level-cache
- reference/security
-
-.. toc::
-
- .. tocheader:: Cookbook
-
- .. toctree::
- :depth: 3
-
- cookbook/aggregate-fields
- cookbook/custom-mapping-types
- cookbook/decorator-pattern
- cookbook/dql-custom-walkers
- cookbook/dql-user-defined-functions
- cookbook/implementing-arrayaccess-for-domain-objects
- cookbook/resolve-target-entity-listener
- cookbook/sql-table-prefixes
- cookbook/strategy-cookbook-introduction
- cookbook/validation-of-entities
- cookbook/working-with-datetime
- cookbook/mysql-enums
- cookbook/advanced-field-value-conversion-using-custom-mapping-types
- cookbook/entities-in-session
+ cookbook/aggregate-fields
+ cookbook/custom-mapping-types
+ cookbook/decorator-pattern
+ cookbook/dql-custom-walkers
+ cookbook/dql-user-defined-functions
+ cookbook/implementing-arrayaccess-for-domain-objects
+ cookbook/resolve-target-entity-listener
+ cookbook/sql-table-prefixes
+ cookbook/strategy-cookbook-introduction
+ cookbook/validation-of-entities
+ cookbook/working-with-datetime
+ cookbook/mysql-enums
+ cookbook/advanced-field-value-conversion-using-custom-mapping-types
+ cookbook/entities-in-session