CompilerPreparation Class Reference

Public Member Functions
	__construct (ServiceManager $serviceManager, ArgvInput $input, File $filesystemDriver)
	handleCompilerEnvironment ()

Detailed Description

Class prepares folders for code generation

Definition at line 23 of file CompilerPreparation.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ServiceManager	$serviceManager,
		ArgvInput	$input,
		File	$filesystemDriver
	)

Parameters

ServiceManager	$serviceManager
ArgvInput	$input
File	$filesystemDriver

Definition at line 50 of file CompilerPreparation.php.

      {
        $this->serviceManager = $serviceManager;
        $this->input = $input;
        $this->filesystemDriver = $filesystemDriver;
    }

Member Function Documentation

handleCompilerEnvironment()

handleCompilerEnvironment

(

)

Determine whether a CLI command is for compilation, and if so, clear the directory.

Exceptions

GenerationDirectoryAccessException

If generation directory is read-only

Returns

void

Definition at line 66 of file CompilerPreparation.php.

    {
        $compilationCommands = $this->getCompilerInvalidationCommands();
        $cmdName = $this->input->getFirstArgument();
        $isHelpOption = $this->input->hasParameterOption('--help') || $this->input->hasParameterOption('-h');
        if (!in_array($cmdName, $compilationCommands) || $isHelpOption) {
            return;
        }

        if (!$this->getGenerationDirectoryAccess()->check()) {
            throw new GenerationDirectoryAccessException();
        }

        $mageInitParams = $this->serviceManager->get(InitParamListener::BOOTSTRAP_PARAM);
        $mageDirs = isset($mageInitParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS])
            ? $mageInitParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS]
            : [];
        $directoryList = new DirectoryList(BP, $mageDirs);
        $compileDirList = [
            $directoryList->getPath(DirectoryList::GENERATED_CODE),
            $directoryList->getPath(DirectoryList::GENERATED_METADATA),
        ];

        foreach ($compileDirList as $compileDir) {
            if ($this->filesystemDriver->isExists($compileDir)) {
                $this->filesystemDriver->deleteDirectory($compileDir);
            }
        }
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/setup/src/Magento/Setup/Console/CompilerPreparation.php