[Summary view] [Print] [Text view]

   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  
  12  namespace Symfony\Component\DependencyInjection\Loader\Configurator\Traits;
  13  
  14  use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  15  
  16  trait DeprecateTrait
  17  {
  18      /**
  19       * Whether this definition is deprecated, that means it should not be called anymore.
  20       *
  21       * @param string $template Template message to use if the definition is deprecated
  22       *
  23       * @return $this
  24       *
  25       * @throws InvalidArgumentException when the message template is invalid
  26       */
  27      final public function deprecate($template = null)
  28      {
  29          $this->definition->setDeprecated(true, $template);
  30  
  31          return $this;
  32      }
  33  }