annotate vendor/symfony/dependency-injection/Loader/Configurator/Traits/DeprecateTrait.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@14 1 <?php
Chris@14 2
Chris@14 3 /*
Chris@14 4 * This file is part of the Symfony package.
Chris@14 5 *
Chris@14 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@14 7 *
Chris@14 8 * For the full copyright and license information, please view the LICENSE
Chris@14 9 * file that was distributed with this source code.
Chris@14 10 */
Chris@14 11
Chris@14 12 namespace Symfony\Component\DependencyInjection\Loader\Configurator\Traits;
Chris@14 13
Chris@14 14 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
Chris@14 15
Chris@14 16 trait DeprecateTrait
Chris@14 17 {
Chris@14 18 /**
Chris@14 19 * Whether this definition is deprecated, that means it should not be called anymore.
Chris@14 20 *
Chris@14 21 * @param string $template Template message to use if the definition is deprecated
Chris@14 22 *
Chris@14 23 * @return $this
Chris@14 24 *
Chris@14 25 * @throws InvalidArgumentException when the message template is invalid
Chris@14 26 */
Chris@14 27 final public function deprecate($template = null)
Chris@14 28 {
Chris@14 29 $this->definition->setDeprecated(true, $template);
Chris@14 30
Chris@14 31 return $this;
Chris@14 32 }
Chris@14 33 }