Add GroupProviderInterface

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php

@@ -101,7 +101,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'twig.runtime',
         'validator.auto_mapper',
         'validator.constraint_validator',
-        'validator.group_sequence_provider',
+        'validator.group_provider',
         'validator.initializer',
         'workflow',
     ];

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -184,6 +184,7 @@
 use Symfony\Component\Uid\UuidV4;
 use Symfony\Component\Validator\Constraints\WhenValidator;
 use Symfony\Component\Validator\ConstraintValidatorInterface;
+use Symfony\Component\Validator\GroupProviderInterface;
 use Symfony\Component\Validator\GroupSequenceProviderInterface;
 use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
 use Symfony\Component\Validator\ObjectInitializerInterface;
@@ -670,8 +671,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('serializer.normalizer');
         $container->registerForAutoconfiguration(ConstraintValidatorInterface::class)
             ->addTag('validator.constraint_validator');
-        $container->registerForAutoconfiguration(GroupSequenceProviderInterface::class)
-            ->addTag('validator.group_sequence_provider');
+        $container->registerForAutoconfiguration(GroupProviderInterface::class)
+            ->addTag('validator.group_provider');
         $container->registerForAutoconfiguration(ObjectInitializerInterface::class)
             ->addTag('validator.initializer');
         $container->registerForAutoconfiguration(MessageHandlerInterface::class)

src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

@@ -67,7 +67,7 @@
 use Symfony\Component\Translation\DependencyInjection\TranslatorPathsPass;
 use Symfony\Component\Validator\DependencyInjection\AddAutoMappingConfigurationPass;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
-use Symfony\Component\Validator\DependencyInjection\AddGroupSequenceProvidersPass;
+use Symfony\Component\Validator\DependencyInjection\AddGroupProvidersPass;
 use Symfony\Component\Validator\DependencyInjection\AddValidatorInitializersPass;
 use Symfony\Component\VarExporter\Internal\Hydrator;
 use Symfony\Component\VarExporter\Internal\Registry;
@@ -149,7 +149,7 @@ public function build(ContainerBuilder $container)
         // but as late as possible to get resolved parameters
         $container->addCompilerPass($registerListenersPass, PassConfig::TYPE_BEFORE_REMOVING);
         $this->addCompilerPassIfExists($container, AddConstraintValidatorsPass::class);
-        $this->addCompilerPassIfExists($container, AddGroupSequenceProvidersPass::class);
+        $this->addCompilerPassIfExists($container, AddGroupProvidersPass::class);
         $container->addCompilerPass(new AddAnnotationsCachedReaderPass(), PassConfig::TYPE_AFTER_REMOVING, -255);
         $this->addCompilerPassIfExists($container, AddValidatorInitializersPass::class);
         $this->addCompilerPassIfExists($container, AddConsoleCommandPass::class, PassConfig::TYPE_BEFORE_REMOVING);

src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.php

@@ -20,7 +20,7 @@
 use Symfony\Component\Validator\Constraints\NotCompromisedPasswordValidator;
 use Symfony\Component\Validator\Constraints\WhenValidator;
 use Symfony\Component\Validator\ContainerConstraintValidatorFactory;
-use Symfony\Component\Validator\ContainerGroupSequenceProviderFactory;
+use Symfony\Component\Validator\ContainerGroupProviderFactory;
 use Symfony\Component\Validator\Mapping\Loader\PropertyInfoLoader;
 use Symfony\Component\Validator\Validation;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
@@ -42,8 +42,8 @@
             ->call('setConstraintValidatorFactory', [
                 service('validator.validator_factory'),
             ])
-            ->call('setGroupSequenceProviderFactory', [
-                service('validator.group_sequence_provider_factory'),
+            ->call('setGroupProviderFactory', [
+                service('validator.group_provider_factory'),
             ])
             ->call('setTranslator', [
                 service('translator')->ignoreOnInvalid(),
@@ -72,9 +72,9 @@
                 abstract_arg('Constraint validators locator'),
             ])
 
-        ->set('validator.group_sequence_provider_factory', ContainerGroupSequenceProviderFactory::class)
+        ->set('validator.group_provider_factory', ContainerGroupProviderFactory::class)
             ->args([
-                abstract_arg('Group sequence provider locator'),
+                abstract_arg('Group provider locator'),
             ])
 
         ->load('Symfony\Component\Validator\Constraints\\', $validatorsDir.'/*Validator.php')

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php

@@ -80,7 +80,7 @@
 use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
 use Symfony\Component\Translation\LocaleSwitcher;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
-use Symfony\Component\Validator\DependencyInjection\AddGroupSequenceProvidersPass;
+use Symfony\Component\Validator\DependencyInjection\AddGroupProvidersPass;
 use Symfony\Component\Validator\Validation;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Validator\ValidatorBuilder;
@@ -1234,8 +1234,8 @@ public function testValidation()
         $this->assertCount($annotations ? 8 : 7, $calls);
         $this->assertSame('setConstraintValidatorFactory', $calls[0][0]);
         $this->assertEquals([new Reference('validator.validator_factory')], $calls[0][1]);
-        $this->assertSame('setGroupSequenceProviderFactory', $calls[1][0]);
-        $this->assertEquals([new Reference('validator.group_sequence_provider_factory')], $calls[1][1]);
+        $this->assertSame('setGroupProviderFactory', $calls[1][0]);
+        $this->assertEquals([new Reference('validator.group_provider_factory')], $calls[1][1]);
         $this->assertSame('setTranslator', $calls[2][0]);
         $this->assertEquals([new Reference('translator', ContainerBuilder::IGNORE_ON_INVALID_REFERENCE)], $calls[2][1]);
         $this->assertSame('setTranslationDomain', $calls[3][0]);
@@ -2385,7 +2385,7 @@ protected function createContainerFromFile(string $file, array $data = [], bool
             $container->getCompilerPassConfig()->setAfterRemovingPasses([]);
         }
         $container->getCompilerPassConfig()->setBeforeOptimizationPasses([new LoggerPass()]);
-        $container->getCompilerPassConfig()->setBeforeRemovingPasses([new AddConstraintValidatorsPass(), new AddGroupSequenceProvidersPass(), new TranslatorPass()]);
+        $container->getCompilerPassConfig()->setBeforeRemovingPasses([new AddConstraintValidatorsPass(), new AddGroupProvidersPass(), new TranslatorPass()]);
         $container->getCompilerPassConfig()->setAfterRemovingPasses([new AddAnnotationsCachedReaderPass()]);
 
         if (!$compile) {

src/Symfony/Component/Validator/CHANGELOG.md

@@ -12,7 +12,7 @@ CHANGELOG
  * Deprecate `ValidatorBuilder::addDefaultDoctrineAnnotationReader()`
  * Add `number`, `finite-number` and `finite-float` types to `Type` constraint
  * Add the `withSeconds` option to the `Time` constraint that allows to pass time without seconds
- * Add support for implementing `GroupSequenceProviderInterface` outside of the underlying class
+ * Add `GroupProviderInterface` to implement validation group providers outside the underlying class
 
 6.3
 ---

src/Symfony/Component/Validator/ContainerGroupSequenceProviderFactory.php → src/Symfony/Component/Validator/ContainerGroupProviderFactory.php

@@ -17,34 +17,34 @@
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
- * Factory class leveraging a PSR-11 container to create or retrieve instances of group sequence providers.
+ * Factory class leveraging a PSR-11 container to create or retrieve instances of validation group providers.
  *
  * @author Yonel Ceruto <yonelceruto@gmail.com>
  */
-class ContainerGroupSequenceProviderFactory implements GroupSequenceProviderFactoryInterface
+class ContainerGroupProviderFactory implements GroupProviderFactoryInterface
 {
     private array $providers = [];
 
     public function __construct(private readonly ContainerInterface $container)
     {
     }
 
-    public function getInstance(string $class): GroupSequenceProviderInterface
+    public function getInstance(string $class): GroupProviderInterface
     {
         if (!isset($this->providers[$class])) {
             if ($this->container->has($class)) {
                 $this->providers[$class] = $this->container->get($class);
             } else {
                 if (!class_exists($class)) {
-                    throw new GroupDefinitionException(sprintf('Group sequence provider "%s" does not exist or is not enabled as service. Check the "class" option in your constraint class "%s".', $class, GroupSequenceProvider::class));
+                    throw new GroupDefinitionException(sprintf('Group provider "%s" does not exist or is not enabled as service. Check the "class" option in your constraint class "%s".', $class, GroupSequenceProvider::class));
                 }
 
                 $this->providers[$class] = new $class();
             }
         }
 
-        if (!$this->providers[$class] instanceof GroupSequenceProviderInterface) {
-            throw new UnexpectedTypeException($this->providers[$class], GroupSequenceProviderInterface::class);
+        if (!$this->providers[$class] instanceof GroupProviderInterface) {
+            throw new UnexpectedTypeException($this->providers[$class], GroupProviderInterface::class);
         }
 
         return $this->providers[$class];

src/Symfony/Component/Validator/DependencyInjection/AddGroupSequenceProvidersPass.php → src/Symfony/Component/Validator/DependencyInjection/AddGroupProvidersPass.php

@@ -19,16 +19,16 @@
 /**
  * @author Yonel Ceruto <yonelceruto@gmail.com>
  */
-class AddGroupSequenceProvidersPass implements CompilerPassInterface
+class AddGroupProvidersPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void
     {
-        if (!$container->hasDefinition('validator.group_sequence_provider_factory')) {
+        if (!$container->hasDefinition('validator.group_provider_factory')) {
             return;
         }
 
         $providers = [];
-        foreach ($container->findTaggedServiceIds('validator.group_sequence_provider', true) as $id => $attributes) {
+        foreach ($container->findTaggedServiceIds('validator.group_provider', true) as $id => $attributes) {
             $definition = $container->getDefinition($id);
 
             if (isset($attributes[0]['alias'])) {
@@ -39,7 +39,7 @@ public function process(ContainerBuilder $container): void
         }
 
         $container
-            ->getDefinition('validator.group_sequence_provider_factory')
+            ->getDefinition('validator.group_provider_factory')
             ->replaceArgument(0, ServiceLocatorTagPass::register($container, $providers))
         ;
     }

src/Symfony/Component/Validator/GroupSequenceProviderFactory.php → src/Symfony/Component/Validator/GroupProviderFactory.php

@@ -12,17 +12,17 @@
 namespace Symfony\Component\Validator;
 
 /**
- * Factory class for creating or retrieving instances of group sequence providers.
+ * Factory class for creating or retrieving instances of validation group providers.
  *
  * @author Yonel Ceruto <yonelceruto@gmail.com>
  */
-class GroupSequenceProviderFactory implements GroupSequenceProviderFactoryInterface
+class GroupProviderFactory implements GroupProviderFactoryInterface
 {
     public function __construct(private array $providers = [])
     {
     }
 
-    public function getInstance(string $class): GroupSequenceProviderInterface
+    public function getInstance(string $class): GroupProviderInterface
     {
         return $this->providers[$class] ??= new $class();
     }

src/Symfony/Component/Validator/GroupSequenceProviderFactoryInterface.php → src/Symfony/Component/Validator/GroupProviderFactoryInterface.php

@@ -12,11 +12,11 @@
 namespace Symfony\Component\Validator;
 
 /**
- * Handles the creation of group sequence providers.
+ * Handles the creation of validation group providers.
  *
  * @author Yonel Ceruto <yonelceruto@gmail.com>
  */
-interface GroupSequenceProviderFactoryInterface
+interface GroupProviderFactoryInterface
 {
-    public function getInstance(string $class): GroupSequenceProviderInterface;
+    public function getInstance(string $class): GroupProviderInterface;
 }

src/Symfony/Component/Validator/GroupProviderInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator;
+
+use Symfony\Component\Validator\Constraints\GroupSequence;
+
+/**
+ * Defines the interface for a validation group provider.
+ */
+interface GroupProviderInterface
+{
+    /**
+     * Returns which validation groups should be used for a certain state
+     * of the object.
+     *
+     * @return string[]|string[][]|GroupSequence
+     */
+    public function getGroups(object $object): array|GroupSequence;
+}

src/Symfony/Component/Validator/Mapping/ClassMetadata.php

@@ -89,9 +89,9 @@ class ClassMetadata extends GenericMetadata implements ClassMetadataInterface
     /**
      * @internal This property is public in order to reduce the size of the
      *           class' serialized representation. Do not access it. Use
-     *           {@link getGroupSequenceProviderClass()} instead.
+     *           {@link getGroupProviderClass()} instead.
      */
-    public ?string $groupSequenceProviderClass = null;
+    public ?string $groupProviderClass = null;
 
     /**
      * The strategy for traversing traversable objects.
@@ -130,7 +130,7 @@ public function __sleep(): array
             'getters',
             'groupSequence',
             'groupSequenceProvider',
-            'groupSequenceProviderClass',
+            'groupProviderClass',
             'members',
             'name',
             'properties',
@@ -327,7 +327,7 @@ public function addGetterMethodConstraints(string $property, string $method, arr
     public function mergeConstraints(self $source)
     {
         if ($source->isGroupSequenceProvider()) {
-            $this->setGroupSequenceProviderClass($source->getGroupSequenceProviderClass());
+            $this->setGroupProviderClass($source->getGroupProviderClass());
             $this->setGroupSequenceProvider(true);
         }
 
@@ -441,7 +441,7 @@ public function setGroupSequenceProvider(bool $active)
             throw new GroupDefinitionException('Defining a group sequence provider is not allowed with a static group sequence.');
         }
 
-        if (null === $this->groupSequenceProviderClass && !$this->getReflectionClass()->implementsInterface(GroupSequenceProviderInterface::class)) {
+        if (null === $this->groupProviderClass && !$this->getReflectionClass()->implementsInterface(GroupSequenceProviderInterface::class)) {
             throw new GroupDefinitionException(sprintf('Class "%s" must implement GroupSequenceProviderInterface.', $this->name));
         }
 
@@ -453,14 +453,14 @@ public function isGroupSequenceProvider(): bool
         return $this->groupSequenceProvider;
     }
 
-    public function setGroupSequenceProviderClass(?string $class): void
+    public function setGroupProviderClass(?string $class): void
     {
-        $this->groupSequenceProviderClass = $class;
+        $this->groupProviderClass = $class;
     }
 
-    public function getGroupSequenceProviderClass(): ?string
+    public function getGroupProviderClass(): ?string
     {
-        return $this->groupSequenceProviderClass;
+        return $this->groupProviderClass;
     }
 
     public function getCascadingStrategy(): int

src/Symfony/Component/Validator/Mapping/ClassMetadataInterface.php

@@ -31,7 +31,7 @@
  * @see GroupSequenceProviderInterface
  * @see TraversalStrategy
  *
- * @method string|null getGroupSequenceProviderClass()
+ * @method string|null getGroupProviderClass()
  */
 interface ClassMetadataInterface extends MetadataInterface
 {

src/Symfony/Component/Validator/Mapping/Loader/AnnotationLoader.php

@@ -53,7 +53,7 @@ public function loadClassMetadata(ClassMetadata $metadata): bool
             if ($constraint instanceof GroupSequence) {
                 $metadata->setGroupSequence($constraint->groups);
             } elseif ($constraint instanceof GroupSequenceProvider) {
-                $metadata->setGroupSequenceProviderClass($constraint->class);
+                $metadata->setGroupProviderClass($constraint->class);
                 $metadata->setGroupSequenceProvider(true);
             } elseif ($constraint instanceof Constraint) {
                 $metadata->addConstraint($constraint);

src/Symfony/Component/Validator/Mapping/Loader/XmlFileLoader.php

@@ -201,7 +201,7 @@ private function loadClassesFromXml(): void
     private function loadClassMetadataFromXml(ClassMetadata $metadata, \SimpleXMLElement $classDescription): void
     {
         if (\count($classDescription->{'group-sequence-provider'}) > 0) {
-            $metadata->setGroupSequenceProviderClass($classDescription->{'group-sequence-provider'}[0]->value ?: null);
+            $metadata->setGroupProviderClass($classDescription->{'group-sequence-provider'}[0]->value ?: null);
             $metadata->setGroupSequenceProvider(true);
         }
 

src/Symfony/Component/Validator/Mapping/Loader/YamlFileLoader.php

@@ -151,7 +151,7 @@ private function loadClassMetadataFromYaml(ClassMetadata $metadata, array $class
     {
         if (isset($classDescription['group_sequence_provider'])) {
             if (\is_string($classDescription['group_sequence_provider'])) {
-                $metadata->setGroupSequenceProviderClass($classDescription['group_sequence_provider']);
+                $metadata->setGroupProviderClass($classDescription['group_sequence_provider']);
             }
             $metadata->setGroupSequenceProvider(
                 (bool) $classDescription['group_sequence_provider']

src/Symfony/Component/Validator/Tests/Constraints/GroupSequenceProviderTest.php

@@ -13,21 +13,21 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Validator\Constraints\GroupSequenceProvider;
-use Symfony\Component\Validator\Tests\Dummy\DummyGroupSequenceProvider;
+use Symfony\Component\Validator\Tests\Dummy\DummyGroupProvider;
 
 class GroupSequenceProviderTest extends TestCase
 {
     public function testCreate()
     {
-        $sequence = new GroupSequenceProvider(['class' => DummyGroupSequenceProvider::class]);
+        $sequence = new GroupSequenceProvider(['class' => DummyGroupProvider::class]);
 
-        $this->assertSame(DummyGroupSequenceProvider::class, $sequence->class);
+        $this->assertSame(DummyGroupProvider::class, $sequence->class);
     }
 
     public function testCreateAttributeStyle()
     {
-        $sequence = new GroupSequenceProvider(class: DummyGroupSequenceProvider::class);
+        $sequence = new GroupSequenceProvider(class: DummyGroupProvider::class);
 
-        $this->assertSame(DummyGroupSequenceProvider::class, $sequence->class);
+        $this->assertSame(DummyGroupProvider::class, $sequence->class);
     }
 }