Skip to content

Mark the definition with the new Document attribute as excluded #970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GromNaN wants to merge 2 commits into
base: 5.6.x
Choose a base branch
from
Open

Mark the definition with the new Document attribute as excluded #970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52fcf3e
Mark the definition with the new Document attribute as excluded from …
GromNaN Dec 16, 2025
1d1c5ad
Use dev version of packages
GromNaN Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/static-analysis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ on:
jobs:
static-analysis:
uses: "doctrine/.github/.github/workflows/[email protected]"
with:
# Remove once doctrine/mongodb-odm 2.16 is released
composer-options: "--minimum-stability=dev"
50 changes: 26 additions & 24 deletions src/DependencyInjection/DoctrineMongoDBExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,8 @@
use Doctrine\Common\EventSubscriber;
use Doctrine\ODM\MongoDB\Configuration as ODMConfiguration;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
use Doctrine\ODM\MongoDB\Mapping\Annotations\EmbeddedDocument;
use Doctrine\ODM\MongoDB\Mapping\Annotations\File;
use Doctrine\ODM\MongoDB\Mapping\Annotations\MappedSuperclass;
use Doctrine\ODM\MongoDB\Mapping\Annotations\QueryResultDocument;
use Doctrine\ODM\MongoDB\Mapping\Annotations\View;
use Doctrine\ODM\MongoDB\Mapping\Annotations;
use Doctrine\ODM\MongoDB\Mapping\Attribute;
use Doctrine\ODM\MongoDB\Mapping\Driver\AttributeDriver;
use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
use Doctrine\Persistence\Proxy;
Expand Down Expand Up @@ -510,24 +506,30 @@ public function load(array $configs, ContainerBuilder $container): void
});

// Document classes are excluded from the container by default
$container->registerAttributeForAutoconfiguration(Document::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', Document::class)]);
});
$container->registerAttributeForAutoconfiguration(EmbeddedDocument::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', EmbeddedDocument::class)]);
});
$container->registerAttributeForAutoconfiguration(MappedSuperclass::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', MappedSuperclass::class)]);
});
$container->registerAttributeForAutoconfiguration(View::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', View::class)]);
});
$container->registerAttributeForAutoconfiguration(QueryResultDocument::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', QueryResultDocument::class)]);
});
$container->registerAttributeForAutoconfiguration(File::class, static function (ChildDefinition $definition): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', File::class)]);
});
foreach (
[
// Deprecated since ODM 2.16
Annotations\Document::class,
Annotations\EmbeddedDocument::class,
Annotations\MappedSuperclass::class,
Annotations\View::class,
Annotations\QueryResultDocument::class,
Annotations\File::class,
// New in ODM 2.16
Attribute\Document::class,
Attribute\EmbeddedDocument::class,
Attribute\MappedSuperclass::class,
Attribute\View::class,
Attribute\QueryResultDocument::class,
Attribute\File::class,
] as $class
) {
if (class_exists($class)) {
$container->registerAttributeForAutoconfiguration($class, static function (ChildDefinition $definition, object $attribute): void {
$definition->addTag('container.excluded', ['source' => sprintf('with #[%s] attribute', $attribute::class)]);
});
}
}

$this->loadMessengerServices($container, $loader);

Expand Down
28 changes: 21 additions & 7 deletions tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
use Doctrine\ODM\MongoDB\Configuration;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\Annotations;
use Doctrine\ODM\MongoDB\Mapping\Attribute;
use InvalidArgumentException;
use MongoDB\Client;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use ProxyManager\Proxy\GhostObjectInterface;
use ReflectionClass;
use stdClass;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ChildDefinition;
Expand All @@ -37,6 +39,7 @@

use function array_diff_key;
use function array_merge;
use function class_exists;
use function interface_exists;
use function is_dir;
use function method_exists;
Expand Down Expand Up @@ -135,18 +138,28 @@ public function testAsDocumentListenerAttribute(): void
public static function provideAttributeExcludedFromContainer(): array
{
return [
'Document' => [Annotations\Document::class],
'EmbeddedDocument' => [Annotations\EmbeddedDocument::class],
'MappedSuperclass' => [Annotations\MappedSuperclass::class],
'View' => [Annotations\View::class],
'QueryResultDocument' => [Annotations\QueryResultDocument::class],
'File' => [Annotations\File::class],
'Annotations\Document' => [Annotations\Document::class],
'Annotations\EmbeddedDocument' => [Annotations\EmbeddedDocument::class],
'Annotations\MappedSuperclass' => [Annotations\MappedSuperclass::class],
'Annotations\View' => [Annotations\View::class],
'Annotations\QueryResultDocument' => [Annotations\QueryResultDocument::class],
'Annotations\File' => [Annotations\File::class],
'Attribute\Document' => [Attribute\Document::class],
'Attribute\EmbeddedDocument' => [Attribute\EmbeddedDocument::class],
'Attribute\MappedSuperclass' => [Attribute\MappedSuperclass::class],
'Attribute\View' => [Attribute\View::class],
'Attribute\QueryResultDocument' => [Attribute\QueryResultDocument::class],
'Attribute\File' => [Attribute\File::class],
];
}

#[DataProvider('provideAttributeExcludedFromContainer')]
public function testDocumentAttributeExcludesFromContainer(string $class): void
{
if (! class_exists($class)) {
$this->markTestSkipped(sprintf('Class %s does not exist.', $class));
}

$container = $this->getContainer();
$extension = new DoctrineMongoDBExtension();
$extension->load($this->buildConfiguration(), $container);
Expand All @@ -164,7 +177,8 @@ public function testDocumentAttributeExcludesFromContainer(string $class): void
$this->assertInstanceOf(Closure::class, $autoconfigurator);

$definition = new ChildDefinition('');
$autoconfigurator($definition);
$attribute = (new ReflectionClass($class))->newInstanceWithoutConstructor();
$autoconfigurator($definition, $attribute);

$this->assertSame([['source' => sprintf('with #[%s] attribute', $class)]], $definition->getTag('container.excluded'));
}
Expand Down
Loading