GeneratedFiles Class Reference

Public Member Functions
	__construct (DirectoryList $directoryList, WriteFactory $writeFactory)
	regenerate ()
	cleanGeneratedFiles ()
	requestRegeneration ()

Data Fields
const	REGENERATE_FLAG = '/var/.regenerate'

Detailed Description

Regenerates generated code and DI configuration

Definition at line 17 of file GeneratedFiles.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DirectoryList	$directoryList,
		WriteFactory	$writeFactory
	)

Constructor

Parameters

DirectoryList	$directoryList
WriteFactory	$writeFactory

Definition at line 40 of file GeneratedFiles.php.

    {
        $this->directoryList = $directoryList;
        $this->write = $writeFactory->create(BP);
    }

Member Function Documentation

cleanGeneratedFiles()

cleanGeneratedFiles

(

)

Clean generated/code, generated/metadata and var/cache

Returns

void

Definition at line 64 of file GeneratedFiles.php.

    {
        if ($this->write->isExist(self::REGENERATE_FLAG)) {
            $enabledCacheTypes = [];

            //TODO: to be removed in scope of MAGETWO-53476
            $deploymentConfig = $this->directoryList->getPath(DirectoryList::CONFIG);
            $configPool = new ConfigFilePool();
            $envPath = $deploymentConfig . '/' . $configPool->getPath(ConfigFilePool::APP_ENV);
            if ($this->write->isExist($this->write->getRelativePath($envPath))) {
                $enabledCacheTypes = $this->getEnabledCacheTypes();
                $this->disableAllCacheTypes();
            }
            //TODO: Till here

            $cachePath = $this->write->getRelativePath($this->directoryList->getPath(DirectoryList::CACHE));
            $generationPath = $this->write->getRelativePath(
                $this->directoryList->getPath(DirectoryList::GENERATED_CODE)
            );
            $diPath = $this->write->getRelativePath($this->directoryList->getPath(DirectoryList::GENERATED_METADATA));

            // Clean generated/code dir
            if ($this->write->isDirectory($generationPath)) {
                $this->write->delete($generationPath);
            }

            // Clean generated/metadata
            if ($this->write->isDirectory($diPath)) {
                $this->write->delete($diPath);
            }

            // Clean var/cache
            if ($this->write->isDirectory($cachePath)) {
                $this->write->delete($cachePath);
            }
            $this->write->delete(self::REGENERATE_FLAG);
            $this->enableCacheTypes($enabledCacheTypes);
        }
    }

regenerate()

regenerate

(

)

Clean generated code and DI configuration

Returns

void

Deprecated:

100.1.0

See also

\Magento\Framework\Code\GeneratedFiles::cleanGeneratedFiles

Definition at line 54 of file GeneratedFiles.php.

    {
        $this->cleanGeneratedFiles();
    }

requestRegeneration()

requestRegeneration

(

)

Create flag for cleaning up generated/code, generated/metadata and var/cache directories for subsequent regeneration of this content

Returns

void

Definition at line 110 of file GeneratedFiles.php.

    {
        $this->write->touch(self::REGENERATE_FLAG);
    }

Field Documentation

REGENERATE_FLAG

const REGENERATE_FLAG = '/var/.regenerate'

Separator literal to assemble timer identifier from timer names

Definition at line 22 of file GeneratedFiles.php.

---

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

• vendor/magento/framework/Code/GeneratedFiles.php