Public Member Functions
	__construct (InputInterface $input, OutputInterface $output, Writer $writer, Reader $reader, MaintenanceMode $maintenanceMode, Filesystem $filesystem, ConfigProvider $configProvider=null, ProcessorFacadeFactory $processorFacadeFactory=null, EmulatedAdminhtmlAreaProcessor $emulatedAreaProcessor=null, MaintenanceModeEnabler $maintenanceModeEnabler=null)

	enableProductionMode ()

	enableProductionModeMinimal ()

	enableDeveloperMode ()

	enableDefaultMode ()

	getMode ()

Protected Member Functions
	setStoreMode ($mode)

Protected Attributes
	$output

Detailed Description

A class to manage Magento modes

@SuppressWarnings("PMD.CouplingBetweenObjects") @SuppressWarnings("PMD.ExcessiveParameterList")

Definition at line 31 of file Mode.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	InputInterface	$input,
		OutputInterface	$output,
		Writer	$writer,
		Reader	$reader,
		MaintenanceMode	$maintenanceMode,
		Filesystem	$filesystem,
		ConfigProvider	$configProvider = `null`,
		ProcessorFacadeFactory	$processorFacadeFactory = `null`,
		EmulatedAdminhtmlAreaProcessor	$emulatedAreaProcessor = `null`,
		MaintenanceModeEnabler	$maintenanceModeEnabler = `null`
	)

Parameters

InputInterface	$input
OutputInterface	$output
Writer	$writer
Reader	$reader
MaintenanceMode	$maintenanceMode	deprecated, use $maintenanceModeEnabler instead
Filesystem	$filesystem
ConfigProvider	$configProvider
ProcessorFacadeFactory	$processorFacadeFactory
EmulatedAdminhtmlAreaProcessor	$emulatedAreaProcessor
MaintenanceModeEnabler	$maintenanceModeEnabler	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 96 of file Mode.php.

       {
         $this->input = $input;
         $this->output = $output;
         $this->writer = $writer;
         $this->reader = $reader;
         $this->filesystem = $filesystem;
 
         $this->configProvider =
             $configProvider ?: ObjectManager::getInstance()->get(ConfigProvider::class);
         $this->processorFacadeFactory =
             $processorFacadeFactory ?: ObjectManager::getInstance()->get(ProcessorFacadeFactory::class);
         $this->emulatedAreaProcessor =
             $emulatedAreaProcessor ?: ObjectManager::getInstance()->get(EmulatedAdminhtmlAreaProcessor::class);
         $this->maintenanceModeEnabler =
             $maintenanceModeEnabler ?: ObjectManager::getInstance()->get(MaintenanceModeEnabler::class);
     }

Member Function Documentation

◆ enableDefaultMode()

enableDefaultMode ( )

Enable Default mode.

Returns: void

Definition at line 185 of file Mode.php.

     {
         $this->filesystem->cleanupFilesystem(
             [
                 DirectoryList::CACHE,
                 DirectoryList::GENERATED_CODE,
                 DirectoryList::GENERATED_METADATA,
                 DirectoryList::TMP_MATERIALIZATION_DIR,
                 DirectoryList::STATIC_VIEW,
             ]
         );
         $this->setStoreMode(State::MODE_DEFAULT);
     }

◆ enableDeveloperMode()

enableDeveloperMode ( )

Enable Developer mode

Returns: void

Definition at line 166 of file Mode.php.

     {
         $this->filesystem->cleanupFilesystem(
             [
                 DirectoryList::CACHE,
                 DirectoryList::GENERATED_CODE,
                 DirectoryList::GENERATED_METADATA,
                 DirectoryList::TMP_MATERIALIZATION_DIR,
                 DirectoryList::STATIC_VIEW,
             ]
         );
         $this->setStoreMode(State::MODE_DEVELOPER);
     }

◆ enableProductionMode()

enableProductionMode ( )

Enable production mode

Exceptions

LocalizedException

Returns: void

Definition at line 130 of file Mode.php.

     {
         $this->maintenanceModeEnabler->executeInMaintenanceMode(
             function () {
                 $previousMode = $this->getMode();
                 try {
                     // We have to turn on production mode before generation.
                     // We need this to enable generation of the "min" files.
                     $this->setStoreMode(State::MODE_PRODUCTION);
                     $this->filesystem->regenerateStatic($this->output);
                 } catch (LocalizedException $e) {
                     // We have to return store mode to previous state in case of error.
                     $this->setStoreMode($previousMode);
                     throw $e;
                 }
             },
             $this->output,
             false
         );
     }

◆ enableProductionModeMinimal()

enableProductionModeMinimal ( )

Only lock static resource locations and set store mode, without handling static content

Returns: void

Definition at line 156 of file Mode.php.

     {
         $this->setStoreMode(State::MODE_PRODUCTION);
     }

◆ getMode()

getMode ( )

Get current mode information

Returns: string

Exceptions

Definition at line 205 of file Mode.php.

     {
         $env = $this->reader->load();
         return isset($env[State::PARAM_MODE]) ? $env[State::PARAM_MODE] : null;
     }

◆ setStoreMode()

setStoreMode ( $mode )

protected

Store mode in env.php

Parameters

string $mode

Returns: void

Definition at line 217 of file Mode.php.

     {
         $this->saveAppConfigs($mode);
         $data = [
             ConfigFilePool::APP_ENV => [
                 State::PARAM_MODE => $mode
             ]
         ];
         $this->writer->saveConfig($data);
     }

Field Documentation

◆ $output

$output