vendor/symfony/dependency-injection/Alias.php line 59

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Component\DependencyInjection;
  14. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  16. class Alias
  17. {
  18.     private $id;
  19.     private $public;
  20.     private $deprecation = [];
  22.     private static $defaultDeprecationTemplate = 'The "%alias_id%" service alias is deprecated. You should stop using it, as it will be removed in the future.';
  24.     public function __construct(string $id, bool $public = false)
  25.     {
  26.         $this->id = $id;
  27.         $this->public = $public;
  28.     }
  30.     /**
  31.      * Checks if this DI Alias should be public or not.
  32.      *
  33.      * @return bool
  34.      */
  35.     public function isPublic()
  36.     {
  37.         return $this->public;
  38.     }
  40.     /**
  41.      * Sets if this Alias is public.
  42.      *
  43.      * @return $this
  44.      */
  45.     public function setPublic(bool $boolean)
  46.     {
  47.         $this->public = $boolean;
  49.         return $this;
  50.     }
  52.     /**
  53.      * Sets if this Alias is private.
  54.      *
  55.      * @return $this
  56.      *
  57.      * @deprecated since Symfony 5.2, use setPublic() instead
  58.      */
  59.     public function setPrivate(bool $boolean)
  60.     {
  61.         trigger_deprecation('symfony/dependency-injection', '5.2', 'The "%s()" method is deprecated, use "setPublic()" instead.', __METHOD__);
  63.         return $this->setPublic(!$boolean);
  64.     }
  66.     /**
  67.      * Whether this alias is private.
  68.      *
  69.      * @return bool
  70.      */
  71.     public function isPrivate()
  72.     {
  73.         return !$this->public;
  74.     }
  76.     /**
  77.      * Whether this alias is deprecated, that means it should not be referenced
  78.      * anymore.
  79.      *
  80.      * @param string $package The name of the composer package that is triggering the deprecation
  81.      * @param string $version The version of the package that introduced the deprecation
  82.      * @param string $message The deprecation message to use
  83.      *
  84.      * @return $this
  85.      *
  86.      * @throws InvalidArgumentException when the message template is invalid
  87.      */
  88.     public function setDeprecated(/* string $package, string $version, string $message */)
  89.     {
  90.         $args = \func_get_args();
  92.         if (\func_num_args() < 3) {
  93.             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__);
  95.             $status = $args[0] ?? true;
  97.             if (!$status) {
  98.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Passing a null message to un-deprecate a node is deprecated.');
  99.             }
  101.             $message = (string) ($args[1] ?? null);
  102.             $package = $version = '';
  103.         } else {
  104.             $status = true;
  105.             $package = (string) $args[0];
  106.             $version = (string) $args[1];
  107.             $message = (string) $args[2];
  108.         }
  110.         if ('' !== $message) {
  111.             if (preg_match('#[\r\n]|\*/#', $message)) {
  112.                 throw new InvalidArgumentException('Invalid characters found in deprecation template.');
  113.             }
  115.             if (false === strpos($message, '%alias_id%')) {
  116.                 throw new InvalidArgumentException('The deprecation template must contain the "%alias_id%" placeholder.');
  117.             }
  118.         }
  120.         $this->deprecation = $status ? ['package' => $package, 'version' => $version, 'message' => $message ?: self::$defaultDeprecationTemplate] : [];
  122.         return $this;
  123.     }
  125.     public function isDeprecated(): bool
  126.     {
  127.         return (bool) $this->deprecation;
  128.     }
  130.     /**
  131.      * @deprecated since Symfony 5.1, use "getDeprecation()" instead.
  132.      */
  133.     public function getDeprecationMessage(string $id): string
  134.     {
  135.         trigger_deprecation('symfony/dependency-injection', '5.1', 'The "%s()" method is deprecated, use "getDeprecation()" instead.', __METHOD__);
  137.         return $this->getDeprecation($id)['message'];
  138.     }
  140.     /**
  141.      * @param string $id Service id relying on this definition
  142.      */
  143.     public function getDeprecation(string $id): array
  144.     {
  145.         return [
  146.             'package' => $this->deprecation['package'],
  147.             'version' => $this->deprecation['version'],
  148.             'message' => str_replace('%alias_id%', $id, $this->deprecation['message']),
  149.         ];
  150.     }
  152.     /**
  153.      * Returns the Id of this alias.
  154.      *
  155.      * @return string The alias id
  156.      */
  157.     public function __toString()
  158.     {
  159.         return $this->id;
  160.     }
  161. }