1. 8.5.x vendor/psr/container/src/ContainerInterface.php ContainerInterface
  2. 8.5.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  3. 8.0.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  4. 8.1.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  5. 8.2.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  6. 8.3.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  7. 8.4.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface
  8. 8.6.x vendor/psr/container/src/ContainerInterface.php ContainerInterface
  9. 8.6.x vendor/symfony/dependency-injection/ContainerInterface.php ContainerInterface

ContainerInterface is the interface implemented by service container classes.

@author Fabien Potencier <fabien@symfony.com> @author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

Expanded class hierarchy of ContainerInterface

All classes that implement ContainerInterface

488 files declare their use of ContainerInterface
AccountForm.php in core/modules/user/src/AccountForm.php
AccountSettingsForm.php in core/modules/user/src/AccountSettingsForm.php
ActionAddForm.php in core/modules/action/src/ActionAddForm.php
ActionAdminManageForm.php in core/modules/action/src/Form/ActionAdminManageForm.php
ActionFormBase.php in core/modules/action/src/ActionFormBase.php

... See full list

File

vendor/symfony/dependency-injection/ContainerInterface.php, line 24

Namespace

Symfony\Component\DependencyInjection
View source
interface ContainerInterface {
  const EXCEPTION_ON_INVALID_REFERENCE = 1;
  const NULL_ON_INVALID_REFERENCE = 2;
  const IGNORE_ON_INVALID_REFERENCE = 3;
  const SCOPE_CONTAINER = 'container';
  const SCOPE_PROTOTYPE = 'prototype';

  /**
   * Sets a service.
   *
   * Note: The $scope parameter is deprecated since version 2.8 and will be removed in 3.0.
   *
   * @param string $id      The service identifier
   * @param object $service The service instance
   * @param string $scope   The scope of the service
   */
  public function set($id, $service, $scope = self::SCOPE_CONTAINER);

  /**
   * Gets a service.
   *
   * @param string $id              The service identifier
   * @param int    $invalidBehavior The behavior when the service does not exist
   *
   * @return object The associated service
   *
   * @throws ServiceCircularReferenceException When a circular reference is detected
   * @throws ServiceNotFoundException          When the service is not defined
   *
   * @see Reference
   */
  public function get($id, $invalidBehavior = self::EXCEPTION_ON_INVALID_REFERENCE);

  /**
   * Returns true if the given service is defined.
   *
   * @param string $id The service identifier
   *
   * @return bool true if the service is defined, false otherwise
   */
  public function has($id);

  /**
   * Gets a parameter.
   *
   * @param string $name The parameter name
   *
   * @return mixed The parameter value
   *
   * @throws InvalidArgumentException if the parameter is not defined
   */
  public function getParameter($name);

  /**
   * Checks if a parameter exists.
   *
   * @param string $name The parameter name
   *
   * @return bool The presence of parameter in container
   */
  public function hasParameter($name);

  /**
   * Sets a parameter.
   *
   * @param string $name  The parameter name
   * @param mixed  $value The parameter value
   */
  public function setParameter($name, $value);

  /**
   * Enters the given scope.
   *
   * @param string $name
   *
   * @deprecated since version 2.8, to be removed in 3.0.
   */
  public function enterScope($name);

  /**
   * Leaves the current scope, and re-enters the parent scope.
   *
   * @param string $name
   *
   * @deprecated since version 2.8, to be removed in 3.0.
   */
  public function leaveScope($name);

  /**
   * Adds a scope to the container.
   *
   * @param ScopeInterface $scope
   *
   * @deprecated since version 2.8, to be removed in 3.0.
   */
  public function addScope(ScopeInterface $scope);

  /**
   * Whether this container has the given scope.
   *
   * @param string $name
   *
   * @return bool
   *
   * @deprecated since version 2.8, to be removed in 3.0.
   */
  public function hasScope($name);

  /**
   * Determines whether the given scope is currently active.
   *
   * It does however not check if the scope actually exists.
   *
   * @param string $name
   *
   * @return bool
   *
   * @deprecated since version 2.8, to be removed in 3.0.
   */
  public function isScopeActive($name);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ContainerInterface::addScope Deprecated public function Adds a scope to the container.
ContainerInterface::enterScope Deprecated public function Enters the given scope.
ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE constant Overrides ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE
ContainerInterface::get public function Gets a service.
ContainerInterface::getParameter public function Gets a parameter.
ContainerInterface::has public function Returns true if the given service is defined.
ContainerInterface::hasParameter public function Checks if a parameter exists.
ContainerInterface::hasScope Deprecated public function Whether this container has the given scope.
ContainerInterface::IGNORE_ON_INVALID_REFERENCE constant Overrides ContainerInterface::IGNORE_ON_INVALID_REFERENCE
ContainerInterface::isScopeActive Deprecated public function Determines whether the given scope is currently active.
ContainerInterface::leaveScope Deprecated public function Leaves the current scope, and re-enters the parent scope.
ContainerInterface::NULL_ON_INVALID_REFERENCE constant Overrides ContainerInterface::NULL_ON_INVALID_REFERENCE
ContainerInterface::SCOPE_CONTAINER constant Overrides ContainerInterface::SCOPE_CONTAINER
ContainerInterface::SCOPE_PROTOTYPE constant Overrides ContainerInterface::SCOPE_PROTOTYPE
ContainerInterface::set public function Sets a service.
ContainerInterface::setParameter public function Sets a parameter.