class InstallerKernel

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Installer/InstallerKernel.php \Drupal\Core\Installer\InstallerKernel
  2. 10 core/lib/Drupal/Core/Installer/InstallerKernel.php \Drupal\Core\Installer\InstallerKernel
  3. 11.x core/lib/Drupal/Core/Installer/InstallerKernel.php \Drupal\Core\Installer\InstallerKernel

Extend DrupalKernel to handle force some kernel behaviors.

Hierarchy

Expanded class hierarchy of InstallerKernel

15 files declare their use of InstallerKernel
block.module in core/modules/block/block.module
Controls the visual building blocks a page is constructed with.
ChainedFastBackendFactory.php in core/lib/Drupal/Core/Cache/ChainedFastBackendFactory.php
ConfigImporterBatch.php in core/lib/Drupal/Core/Config/Importer/ConfigImporterBatch.php
ConfigImportSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php
ConfigInstaller.php in core/lib/Drupal/Core/Config/ConfigInstaller.php

... See full list

File

core/lib/Drupal/Core/Installer/InstallerKernel.php, line 10

Namespace

Drupal\Core\Installer
View source
class InstallerKernel extends DrupalKernel {
    
    /**
     * {@inheritdoc}
     */
    protected function initializeContainer() {
        // Always force a container rebuild.
        $this->containerNeedsRebuild = TRUE;
        // Ensure the InstallerKernel's container is not dumped.
        $this->allowDumping = FALSE;
        $container = parent::initializeContainer();
        return $container;
    }
    
    /**
     * Reset the bootstrap config storage.
     *
     * Use this from a database driver runTasks() if the method overrides the
     * bootstrap config storage. Normally the bootstrap config storage is not
     * re-instantiated during a single install request. Most drivers will not
     * need this method.
     *
     * @see \Drupal\Core\Database\Install\Tasks::runTasks()
     */
    public function resetConfigStorage() {
        $this->configStorage = NULL;
    }
    
    /**
     * Returns the active configuration storage used during early install.
     *
     * This override changes the visibility so that the installer can access
     * config storage before the container is properly built.
     *
     * @return \Drupal\Core\Config\StorageInterface
     *   The config storage.
     */
    public function getConfigStorage() {
        return parent::getConfigStorage();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getInstallProfile() {
        global $install_state;
        if ($install_state && empty($install_state['installation_finished'])) {
            // If the profile has been selected return it.
            if (isset($install_state['parameters']['profile'])) {
                $profile = $install_state['parameters']['profile'];
            }
            else {
                $profile = NULL;
            }
        }
        else {
            $profile = parent::getInstallProfile();
        }
        return $profile;
    }
    
    /**
     * Returns TRUE if a Drupal installation is currently being attempted.
     *
     * @return bool
     *   TRUE if the installation is currently being attempted.
     */
    public static function installationAttempted() {
        // This cannot rely on the MAINTENANCE_MODE constant, since that would
        // prevent tests from using the non-interactive installer, in which case
        // Drupal only happens to be installed within the same request, but
        // subsequently executed code does not involve the installer at all.
        // @see install_drupal()
        return isset($GLOBALS['install_state']) && empty($GLOBALS['install_state']['installation_finished']);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DrupalKernel::$allowDumping protected property Whether the container can be dumped.
DrupalKernel::$booted protected property Whether the kernel has been booted.
DrupalKernel::$bootstrapContainer protected property Holds the bootstrap container.
DrupalKernel::$bootstrapContainerClass protected property Holds the class used for instantiating the bootstrap container.
DrupalKernel::$classLoader protected property The class loader object.
DrupalKernel::$configStorage protected property Config storage object used for reading enabled modules configuration.
DrupalKernel::$container protected property Holds the container instance.
DrupalKernel::$containerNeedsDumping protected property Whether the container needs to be dumped once booting is complete.
DrupalKernel::$containerNeedsRebuild protected property Whether the container needs to be rebuilt the next time it is initialized.
DrupalKernel::$defaultBootstrapContainerDefinition protected property Holds the default bootstrap container definition.
DrupalKernel::$environment protected property The environment, e.g. 'testing', 'install'.
DrupalKernel::$isEnvironmentInitialized protected static property Whether the PHP environment has been initialized.
DrupalKernel::$moduleData protected property List of available modules and installation profiles.
DrupalKernel::$moduleList protected property Holds the list of enabled modules.
DrupalKernel::$phpArrayDumperClass protected property Holds the class used for dumping the container to a PHP array.
DrupalKernel::$prepared protected property Whether essential services have been set up properly by preHandle().
DrupalKernel::$root protected property The app root.
DrupalKernel::$serviceIdMapping Deprecated protected property A mapping from service classes to service IDs.
DrupalKernel::$serviceProviderClasses protected property List of discovered service provider class names or objects.
DrupalKernel::$serviceProviders protected property List of instantiated service provider classes.
DrupalKernel::$serviceYamls protected property List of discovered services.yml pathnames.
DrupalKernel::$sitePath protected property The site path directory.
DrupalKernel::addServiceFiles protected function Add service files.
DrupalKernel::attachSynthetic protected function Attach synthetic values on to kernel.
DrupalKernel::boot public function Overrides DrupalKernelInterface::boot 1
DrupalKernel::bootEnvironment public static function Setup a consistent PHP environment.
DrupalKernel::cacheDrupalContainer protected function Stores the container definition in a cache. 1
DrupalKernel::classLoaderAddMultiplePsr4 protected function Registers a list of namespaces with PSR-4 directories for class loading.
DrupalKernel::collectServiceIdMapping Deprecated protected function Collect a mapping between service to ids.
DrupalKernel::compileContainer protected function Compiles a new service container.
DrupalKernel::createFromRequest public static function Create a DrupalKernel object from a request. 1
DrupalKernel::discoverServiceProviders public function Overrides DrupalKernelInterface::discoverServiceProviders 2
DrupalKernel::findSitePath public static function Returns the appropriate site directory for a request.
DrupalKernel::generateServiceIdHash Deprecated public static function Generate a unique hash for a service object.
DrupalKernel::getAppRoot public function Overrides DrupalKernelInterface::getAppRoot
DrupalKernel::getCachedContainerDefinition public function Overrides DrupalKernelInterface::getCachedContainerDefinition
DrupalKernel::getContainer public function Overrides DrupalKernelInterface::getContainer
DrupalKernel::getContainerBuilder protected function Gets a new ContainerBuilder instance used to build the service container.
DrupalKernel::getContainerCacheKey protected function Returns the container cache key based on the environment.
DrupalKernel::getHttpKernel protected function Gets a http kernel from the container.
DrupalKernel::getKernelParameters protected function Returns the kernel parameters.
DrupalKernel::getModuleFileNames protected function Gets the file name for each enabled module.
DrupalKernel::getModuleNamespacesPsr4 protected function Gets the PSR-4 base directories for module namespaces.
DrupalKernel::getModulesParameter protected function Returns an array of Extension class parameters for all enabled modules.
DrupalKernel::getServiceIdMapping public function Overrides DrupalKernelInterface::getServiceIdMapping
DrupalKernel::getServiceProviders public function Overrides DrupalKernelInterface::getServiceProviders
DrupalKernel::getServicesToPersist protected function Returns service instances to persist from an old container to a new one.
DrupalKernel::getSitePath public function Overrides DrupalKernelInterface::getSitePath
DrupalKernel::guessApplicationRoot protected static function Determine the application root directory based on this file's location.
DrupalKernel::handle public function 1
DrupalKernel::handleException protected function Converts an exception into a response.
DrupalKernel::initializeRequestGlobals protected function Bootstraps the legacy global request variables.
DrupalKernel::initializeServiceProviders protected function Registers all service providers to the kernel.
DrupalKernel::initializeSettings protected function Locate site path and initialize settings singleton.
DrupalKernel::invalidateContainer public function Overrides DrupalKernelInterface::invalidateContainer
DrupalKernel::loadLegacyIncludes public function Overrides DrupalKernelInterface::loadLegacyIncludes
DrupalKernel::moduleData protected function Returns module data on the filesystem.
DrupalKernel::persistServices protected function Moves persistent service instances into a new container.
DrupalKernel::preHandle public function Overrides DrupalKernelInterface::preHandle
DrupalKernel::rebuildContainer public function Overrides DrupalKernelInterface::rebuildContainer
DrupalKernel::setContainer public function
DrupalKernel::setSitePath public function Overrides DrupalKernelInterface::setSitePath
DrupalKernel::setupTrustedHosts protected static function Sets up the lists of trusted HTTP Host headers.
DrupalKernel::shutdown public function Overrides DrupalKernelInterface::shutdown
DrupalKernel::terminate public function
DrupalKernel::updateModules public function Implements Drupal\Core\DrupalKernelInterface::updateModules(). Overrides DrupalKernelInterface::updateModules
DrupalKernel::validateHostname public static function Validates the hostname supplied from the HTTP request.
DrupalKernel::validateHostnameLength protected static function Validates a hostname length.
DrupalKernel::__construct public function Constructs a DrupalKernel object. 2
DrupalKernelInterface::CONTAINER_INITIALIZE_SUBREQUEST_FINISHED constant Event fired when the service container finished initializing in subrequest.
InstallerKernel::getConfigStorage public function Returns the active configuration storage used during early install. Overrides DrupalKernel::getConfigStorage
InstallerKernel::getInstallProfile public function Overrides DrupalKernel::getInstallProfile
InstallerKernel::initializeContainer protected function Overrides DrupalKernel::initializeContainer
InstallerKernel::installationAttempted public static function Returns TRUE if a Drupal installation is currently being attempted.
InstallerKernel::resetConfigStorage public function Reset the bootstrap config storage.
InstallerRedirectTrait::isCli protected function Returns whether the current PHP process runs on CLI.
InstallerRedirectTrait::shouldRedirectToInstaller protected function Determines if an exception handler should redirect to the installer.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.