interface BundleInterface

BundleInterface.

@author Fabien Potencier <fabien@symfony.com>

@api

Hierarchy

Expanded class hierarchy of BundleInterface

All classes that implement BundleInterface

2 files declare their use of BundleInterface
Kernel.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Kernel.php
KernelInterface.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/KernelInterface.php

File

drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Bundle/BundleInterface.php, line 25

Namespace

Symfony\Component\HttpKernel\Bundle
View source
interface BundleInterface extends ContainerAwareInterface {

  /**
   * Boots the Bundle.
   *
   * @api
   */
  public function boot();

  /**
   * Shutdowns the Bundle.
   *
   * @api
   */
  public function shutdown();

  /**
   * Builds the bundle.
   *
   * It is only ever called once when the cache is empty.
   *
   * @param ContainerBuilder $container A ContainerBuilder instance
   *
   * @api
   */
  public function build(ContainerBuilder $container);

  /**
   * Returns the container extension that should be implicitly loaded.
   *
   * @return ExtensionInterface|null The default extension or null if there is none
   *
   * @api
   */
  public function getContainerExtension();

  /**
   * Returns the bundle name that this bundle overrides.
   *
   * Despite its name, this method does not imply any parent/child relationship
   * between the bundles, just a way to extend and override an existing
   * bundle.
   *
   * @return string The Bundle name it overrides or null if no parent
   *
   * @api
   */
  public function getParent();

  /**
   * Returns the bundle name (the class short name).
   *
   * @return string The Bundle name
   *
   * @api
   */
  public function getName();

  /**
   * Gets the Bundle namespace.
   *
   * @return string The Bundle namespace
   *
   * @api
   */
  public function getNamespace();

  /**
   * Gets the Bundle directory path.
   *
   * The path should always be returned as a Unix path (with /).
   *
   * @return string The Bundle absolute path
   *
   * @api
   */
  public function getPath();

}

Members

Namesort descending Modifiers Type Description Overrides
BundleInterface::boot public function Boots the Bundle. 1
BundleInterface::build public function Builds the bundle. 1
BundleInterface::getContainerExtension public function Returns the container extension that should be implicitly loaded. 1
BundleInterface::getName public function Returns the bundle name (the class short name). 1
BundleInterface::getNamespace public function Gets the Bundle namespace. 1
BundleInterface::getParent public function Returns the bundle name that this bundle overrides. 1
BundleInterface::getPath public function Gets the Bundle directory path. 1
BundleInterface::shutdown public function Shutdowns the Bundle. 1
ContainerAwareInterface::setContainer public function Sets the Container. 2