[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\HttpKernel;
  13  
  14  use Symfony\Component\DependencyInjection\ContainerInterface;
  15  use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  16  use Symfony\Component\Config\Loader\LoaderInterface;
  17  
  18  /**
  19   * The Kernel is the heart of the Symfony system.
  20   *
  21   * It manages an environment made of bundles.
  22   *
  23   * @author Fabien Potencier <fabien@symfony.com>
  24   */
  25  interface KernelInterface extends HttpKernelInterface, \Serializable
  26  {
  27      /**
  28       * Returns an array of bundles to register.
  29       *
  30       * @return BundleInterface[] An array of bundle instances.
  31       */
  32      public function registerBundles();
  33  
  34      /**
  35       * Loads the container configuration.
  36       *
  37       * @param LoaderInterface $loader A LoaderInterface instance
  38       */
  39      public function registerContainerConfiguration(LoaderInterface $loader);
  40  
  41      /**
  42       * Boots the current kernel.
  43       */
  44      public function boot();
  45  
  46      /**
  47       * Shutdowns the kernel.
  48       *
  49       * This method is mainly useful when doing functional testing.
  50       */
  51      public function shutdown();
  52  
  53      /**
  54       * Gets the registered bundle instances.
  55       *
  56       * @return BundleInterface[] An array of registered bundle instances
  57       */
  58      public function getBundles();
  59  
  60      /**
  61       * Checks if a given class name belongs to an active bundle.
  62       *
  63       * @param string $class A class name
  64       *
  65       * @return bool true if the class belongs to an active bundle, false otherwise
  66       */
  67      public function isClassInActiveBundle($class);
  68  
  69      /**
  70       * Returns a bundle and optionally its descendants by its name.
  71       *
  72       * @param string $name  Bundle name
  73       * @param bool   $first Whether to return the first bundle only or together with its descendants
  74       *
  75       * @return BundleInterface|BundleInterface[] A BundleInterface instance or an array of BundleInterface instances if $first is false
  76       *
  77       * @throws \InvalidArgumentException when the bundle is not enabled
  78       */
  79      public function getBundle($name, $first = true);
  80  
  81      /**
  82       * Returns the file path for a given resource.
  83       *
  84       * A Resource can be a file or a directory.
  85       *
  86       * The resource name must follow the following pattern:
  87       *
  88       *     "@BundleName/path/to/a/file.something"
  89       *
  90       * where BundleName is the name of the bundle
  91       * and the remaining part is the relative path in the bundle.
  92       *
  93       * If $dir is passed, and the first segment of the path is "Resources",
  94       * this method will look for a file named:
  95       *
  96       *     $dir/<BundleName>/path/without/Resources
  97       *
  98       * before looking in the bundle resource folder.
  99       *
 100       * @param string $name  A resource name to locate
 101       * @param string $dir   A directory where to look for the resource first
 102       * @param bool   $first Whether to return the first path or paths for all matching bundles
 103       *
 104       * @return string|array The absolute path of the resource or an array if $first is false
 105       *
 106       * @throws \InvalidArgumentException if the file cannot be found or the name is not valid
 107       * @throws \RuntimeException         if the name contains invalid/unsafe characters
 108       */
 109      public function locateResource($name, $dir = null, $first = true);
 110  
 111      /**
 112       * Gets the name of the kernel.
 113       *
 114       * @return string The kernel name
 115       */
 116      public function getName();
 117  
 118      /**
 119       * Gets the environment.
 120       *
 121       * @return string The current environment
 122       */
 123      public function getEnvironment();
 124  
 125      /**
 126       * Checks if debug mode is enabled.
 127       *
 128       * @return bool true if debug mode is enabled, false otherwise
 129       */
 130      public function isDebug();
 131  
 132      /**
 133       * Gets the application root dir.
 134       *
 135       * @return string The application root dir
 136       */
 137      public function getRootDir();
 138  
 139      /**
 140       * Gets the current container.
 141       *
 142       * @return ContainerInterface A ContainerInterface instance
 143       */
 144      public function getContainer();
 145  
 146      /**
 147       * Gets the request start time (not available if debug is disabled).
 148       *
 149       * @return int The request start timestamp
 150       */
 151      public function getStartTime();
 152  
 153      /**
 154       * Gets the cache directory.
 155       *
 156       * @return string The cache directory
 157       */
 158      public function getCacheDir();
 159  
 160      /**
 161       * Gets the log directory.
 162       *
 163       * @return string The log directory
 164       */
 165      public function getLogDir();
 166  
 167      /**
 168       * Gets the charset of the application.
 169       *
 170       * @return string The charset
 171       */
 172      public function getCharset();
 173  }