Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
10 / 10
DeprecateTrait
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
10 / 10
 deprecate
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
10 / 10
1<?php
2
3/*
4 * This file is part of the Symfony package.
5 *
6 * (c) Fabien Potencier <fabien@symfony.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12namespace Symfony\Component\DependencyInjection\Loader\Configurator\Traits;
13
14use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
15
16trait DeprecateTrait
17{
18    /**
19     * Whether this definition is deprecated, that means it should not be called anymore.
20     *
21     * @param string $package The name of the composer package that is triggering the deprecation
22     * @param string $version The version of the package that introduced the deprecation
23     * @param string $message The deprecation message to use
24     *
25     * @return $this
26     *
27     * @throws InvalidArgumentException when the message template is invalid
28     */
29    final public function deprecate(/* string $package, string $version, string $message */): self
30    {
31        $args = \func_get_args();
32        $package = $version = $message = '';
33
34        if (\func_num_args() < 3) {
35            trigger_deprecation('symfony/dependency-injection', '5.1', 'The signature of method "%s()" requires 3 arguments: "string $package, string $version, string $message", not defining them is deprecated.', __METHOD__);
36
37            $message = (string) ($args[0] ?? null);
38        } else {
39            $package = (string) $args[0];
40            $version = (string) $args[1];
41            $message = (string) $args[2];
42        }
43
44        $this->definition->setDeprecated($package, $version, $message);
45
46        return $this;
47    }
48}