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

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 $private;
  21.     private $deprecation = [];
  23.     private static $defaultDeprecationTemplate = 'The "%alias_id%" service alias is deprecated. You should stop using it, as it will be removed in the future.';
  25.     public function __construct(string $id, bool $public = true)
  26.     {
  27.         $this->id = $id;
  28.         $this->public = $public;
  29.         $this->private = 2 > \func_num_args();
  30.     }
  32.     /**
  33.      * Checks if this DI Alias should be public or not.
  34.      *
  35.      * @return bool
  36.      */
  37.     public function isPublic()
  38.     {
  39.         return $this->public;
  40.     }
  42.     /**
  43.      * Sets if this Alias is public.
  44.      *
  45.      * @return $this
  46.      */
  47.     public function setPublic(bool $boolean)
  48.     {
  49.         $this->public = $boolean;
  50.         $this->private = false;
  52.         return $this;
  53.     }
  55.     /**
  56.      * Sets if this Alias is private.
  57.      *
  58.      * When set, the "private" state has a higher precedence than "public".
  59.      * In version 3.4, a "private" alias always remains publicly accessible,
  60.      * but triggers a deprecation notice when accessed from the container,
  61.      * so that the alias can be made really private in 4.0.
  62.      *
  63.      * @return $this
  64.      */
  65.     public function setPrivate(bool $boolean)
  66.     {
  67.         $this->private = $boolean;
  69.         return $this;
  70.     }
  72.     /**
  73.      * Whether this alias is private.
  74.      *
  75.      * @return bool
  76.      */
  77.     public function isPrivate()
  78.     {
  79.         return $this->private;
  80.     }
  82.     /**
  83.      * Whether this alias is deprecated, that means it should not be referenced
  84.      * anymore.
  85.      *
  86.      * @param string $package The name of the composer package that is triggering the deprecation
  87.      * @param string $version The version of the package that introduced the deprecation
  88.      * @param string $message The deprecation message to use
  89.      *
  90.      * @return $this
  91.      *
  92.      * @throws InvalidArgumentException when the message template is invalid
  93.      */
  94.     public function setDeprecated(/* string $package, string $version, string $message */)
  95.     {
  96.         $args = \func_get_args();
  98.         if (\func_num_args() < 3) {
  99.             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__);
  101.             $status = $args[0] ?? true;
  103.             if (!$status) {
  104.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Passing a null message to un-deprecate a node is deprecated.');
  105.             }
  107.             $message = (string) ($args[1] ?? null);
  108.             $package = $version = '';
  109.         } else {
  110.             $status = true;
  111.             $package = (string) $args[0];
  112.             $version = (string) $args[1];
  113.             $message = (string) $args[2];
  114.         }
  116.         if ('' !== $message) {
  117.             if (preg_match('#[\r\n]|\*/#', $message)) {
  118.                 throw new InvalidArgumentException('Invalid characters found in deprecation template.');
  119.             }
  121.             if (false === strpos($message, '%alias_id%')) {
  122.                 throw new InvalidArgumentException('The deprecation template must contain the "%alias_id%" placeholder.');
  123.             }
  124.         }
  126.         $this->deprecation = $status ? ['package' => $package, 'version' => $version, 'message' => $message ?: self::$defaultDeprecationTemplate] : [];
  128.         return $this;
  129.     }
  131.     public function isDeprecated(): bool
  132.     {
  133.         return (bool) $this->deprecation;
  134.     }
  136.     /**
  137.      * @deprecated since Symfony 5.1, use "getDeprecation()" instead.
  138.      */
  139.     public function getDeprecationMessage(string $id): string
  140.     {
  141.         trigger_deprecation('symfony/dependency-injection', '5.1', 'The "%s()" method is deprecated, use "getDeprecation()" instead.', __METHOD__);
  143.         return $this->getDeprecation($id)['message'];
  144.     }
  146.     /**
  147.      * @param string $id Service id relying on this definition
  148.      */
  149.     public function getDeprecation(string $id): array
  150.     {
  151.         return [
  152.             'package' => $this->deprecation['package'],
  153.             'version' => $this->deprecation['version'],
  154.             'message' => str_replace('%alias_id%', $id, $this->deprecation['message']),
  155.         ];
  156.     }
  158.     /**
  159.      * Returns the Id of this alias.
  160.      *
  161.      * @return string The alias id
  162.      */
  163.     public function __toString()
  164.     {
  165.         return $this->id;
  166.     }
  167. }