KernelInterface.php 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpKernel;
  11. use Symfony\Component\Config\Loader\LoaderInterface;
  12. use Symfony\Component\DependencyInjection\ContainerInterface;
  13. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  14. /**
  15. * The Kernel is the heart of the Symfony system.
  16. *
  17. * It manages an environment made of application kernel and bundles.
  18. *
  19. * @method string getBuildDir() Returns the build directory - not implementing it is deprecated since Symfony 5.2.
  20. * This directory should be used to store build artifacts, and can be read-only at runtime.
  21. * Caches written at runtime should be stored in the "cache directory" ({@see KernelInterface::getCacheDir()}).
  22. *
  23. * @author Fabien Potencier <fabien@symfony.com>
  24. */
  25. interface KernelInterface extends HttpKernelInterface
  26. {
  27. /**
  28. * Returns an array of bundles to register.
  29. *
  30. * @return iterable|BundleInterface[] An iterable of bundle instances
  31. */
  32. public function registerBundles();
  33. /**
  34. * Loads the container configuration.
  35. */
  36. public function registerContainerConfiguration(LoaderInterface $loader);
  37. /**
  38. * Boots the current kernel.
  39. */
  40. public function boot();
  41. /**
  42. * Shutdowns the kernel.
  43. *
  44. * This method is mainly useful when doing functional testing.
  45. */
  46. public function shutdown();
  47. /**
  48. * Gets the registered bundle instances.
  49. *
  50. * @return BundleInterface[] An array of registered bundle instances
  51. */
  52. public function getBundles();
  53. /**
  54. * Returns a bundle.
  55. *
  56. * @return BundleInterface A BundleInterface instance
  57. *
  58. * @throws \InvalidArgumentException when the bundle is not enabled
  59. */
  60. public function getBundle(string $name);
  61. /**
  62. * Returns the file path for a given bundle resource.
  63. *
  64. * A Resource can be a file or a directory.
  65. *
  66. * The resource name must follow the following pattern:
  67. *
  68. * "@BundleName/path/to/a/file.something"
  69. *
  70. * where BundleName is the name of the bundle
  71. * and the remaining part is the relative path in the bundle.
  72. *
  73. * @return string The absolute path of the resource
  74. *
  75. * @throws \InvalidArgumentException if the file cannot be found or the name is not valid
  76. * @throws \RuntimeException if the name contains invalid/unsafe characters
  77. */
  78. public function locateResource(string $name);
  79. /**
  80. * Gets the environment.
  81. *
  82. * @return string The current environment
  83. */
  84. public function getEnvironment();
  85. /**
  86. * Checks if debug mode is enabled.
  87. *
  88. * @return bool true if debug mode is enabled, false otherwise
  89. */
  90. public function isDebug();
  91. /**
  92. * Gets the project dir (path of the project's composer file).
  93. *
  94. * @return string
  95. */
  96. public function getProjectDir();
  97. /**
  98. * Gets the current container.
  99. *
  100. * @return ContainerInterface
  101. */
  102. public function getContainer();
  103. /**
  104. * Gets the request start time (not available if debug is disabled).
  105. *
  106. * @return float The request start timestamp
  107. */
  108. public function getStartTime();
  109. /**
  110. * Gets the cache directory.
  111. *
  112. * Since Symfony 5.2, the cache directory should be used for caches that are written at runtime.
  113. * For caches and artifacts that can be warmed at compile-time and deployed as read-only,
  114. * use the new "build directory" returned by the {@see getBuildDir()} method.
  115. *
  116. * @return string The cache directory
  117. */
  118. public function getCacheDir();
  119. /**
  120. * Gets the log directory.
  121. *
  122. * @return string The log directory
  123. */
  124. public function getLogDir();
  125. /**
  126. * Gets the charset of the application.
  127. *
  128. * @return string The charset
  129. */
  130. public function getCharset();
  131. }