annotate vendor/symfony/dependency-injection/ContainerInterface.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@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\DependencyInjection;
Chris@0 13
Chris@14 14 use Psr\Container\ContainerInterface as PsrContainerInterface;
Chris@0 15 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
Chris@0 16 use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
Chris@0 17 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
Chris@0 18
Chris@0 19 /**
Chris@0 20 * ContainerInterface is the interface implemented by service container classes.
Chris@0 21 *
Chris@0 22 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 23 * @author Johannes M. Schmitt <schmittjoh@gmail.com>
Chris@0 24 */
Chris@14 25 interface ContainerInterface extends PsrContainerInterface
Chris@0 26 {
Chris@0 27 const EXCEPTION_ON_INVALID_REFERENCE = 1;
Chris@0 28 const NULL_ON_INVALID_REFERENCE = 2;
Chris@0 29 const IGNORE_ON_INVALID_REFERENCE = 3;
Chris@14 30 const IGNORE_ON_UNINITIALIZED_REFERENCE = 4;
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Sets a service.
Chris@0 34 *
Chris@0 35 * @param string $id The service identifier
Chris@0 36 * @param object $service The service instance
Chris@0 37 */
Chris@0 38 public function set($id, $service);
Chris@0 39
Chris@0 40 /**
Chris@0 41 * Gets a service.
Chris@0 42 *
Chris@0 43 * @param string $id The service identifier
Chris@0 44 * @param int $invalidBehavior The behavior when the service does not exist
Chris@0 45 *
Chris@0 46 * @return object The associated service
Chris@0 47 *
Chris@0 48 * @throws ServiceCircularReferenceException When a circular reference is detected
Chris@0 49 * @throws ServiceNotFoundException When the service is not defined
Chris@0 50 *
Chris@0 51 * @see Reference
Chris@0 52 */
Chris@0 53 public function get($id, $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE);
Chris@0 54
Chris@0 55 /**
Chris@0 56 * Returns true if the given service is defined.
Chris@0 57 *
Chris@0 58 * @param string $id The service identifier
Chris@0 59 *
Chris@0 60 * @return bool true if the service is defined, false otherwise
Chris@0 61 */
Chris@0 62 public function has($id);
Chris@0 63
Chris@0 64 /**
Chris@0 65 * Check for whether or not a service has been initialized.
Chris@0 66 *
Chris@0 67 * @param string $id
Chris@0 68 *
Chris@0 69 * @return bool true if the service has been initialized, false otherwise
Chris@0 70 */
Chris@0 71 public function initialized($id);
Chris@0 72
Chris@0 73 /**
Chris@0 74 * Gets a parameter.
Chris@0 75 *
Chris@0 76 * @param string $name The parameter name
Chris@0 77 *
Chris@0 78 * @return mixed The parameter value
Chris@0 79 *
Chris@0 80 * @throws InvalidArgumentException if the parameter is not defined
Chris@0 81 */
Chris@0 82 public function getParameter($name);
Chris@0 83
Chris@0 84 /**
Chris@0 85 * Checks if a parameter exists.
Chris@0 86 *
Chris@0 87 * @param string $name The parameter name
Chris@0 88 *
Chris@0 89 * @return bool The presence of parameter in container
Chris@0 90 */
Chris@0 91 public function hasParameter($name);
Chris@0 92
Chris@0 93 /**
Chris@0 94 * Sets a parameter.
Chris@0 95 *
Chris@0 96 * @param string $name The parameter name
Chris@0 97 * @param mixed $value The parameter value
Chris@0 98 */
Chris@0 99 public function setParameter($name, $value);
Chris@0 100 }