public function setDeprecated(string $option, string $package, string $version, string|\Closure $message = 'The option "%name%" is deprecated.'): static


La méthode setDeprecated() dans le composant OptionsResolver de Symfony est utilisée pour marquer une option comme étant obsolète


  • $option : Le nom de l'option que vous souhaitez marquer comme obsolète.

  • $package : Le nom du package qui déclare l'option obsolète.

  • $version : La version dans laquelle l'option a été marquée comme obsolète.

  • $message : Le message d'avertissement qui sera déclenché lorsque l'option obsolète est utilisée. Le message doit informer l'utilisateur de la raison de l'obsolescence et, si possible, quelle option utiliser à la place.


Utilisation

use Symfony\Component\OptionsResolver\OptionsResolver;

$resolver = new OptionsResolver();

$resolver->setDefined('my_old_option');
$resolver->setDeprecated(
    'my_old_option',
    'MyPackage',
    '1.2',
    'L\'option "my_old_option" est obsolète depuis la version 1.2. Utilisez "my_new_option" à la place.'
);


Supposons que vous ayez une option timeout dans votre composant, et que vous souhaitiez la renommer en connection_timeout. Vous pouvez marquer l'ancienne option comme obsolète :

$resolver->setDefined('timeout');
$resolver->setDeprecated(
    'timeout',
    'MyComponent',
    '2.0',
    'L\'option "timeout" est obsolète depuis la version 2.0. Utilisez "connection_timeout" à la place.'
);
$resolver->setDefined('connection_timeout');
$resolver->setDefault('connection_timeout', 10); // Valeur par défaut pour la nouvelle option


Powered by Froala Editor