Filesystem Class Reference

Public Member Functions
	__construct (\Magento\Framework\App\DeploymentConfig\Writer $writer, \Magento\Framework\App\DeploymentConfig\Reader $reader, \Magento\Framework\ObjectManagerInterface $objectManager, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\App\Filesystem\DirectoryList $directoryList, \Magento\Framework\Filesystem\Driver\File $driverFile, \Magento\Store\Model\Config\StoreView $storeView, \Magento\Framework\ShellInterface $shell, UserCollection $userCollection=null, Locale $locale=null)
	regenerateStatic (OutputInterface $output)
	cleanupFilesystem ($directoryCodeList)
	lockStaticResources ()

Data Fields
const	PERMISSIONS_FILE = 0640
const	PERMISSIONS_DIR = 0750
const	DEFAULT_THEME = 'Magento/blank'

Protected Member Functions
	deployStaticContent (OutputInterface $output)
	compile (OutputInterface $output)
	changePermissions ($directoryCodeList, $dirPermissions, $filePermissions)

Detailed Description

Generate static files, compile

Сlear generated/code, generated/metadata/, var/view_preprocessed and pub/static directories

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file Filesystem.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\DeploymentConfig\Writer	$writer,
		\Magento\Framework\App\DeploymentConfig\Reader	$reader,
		\Magento\Framework\ObjectManagerInterface	$objectManager,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\App\Filesystem\DirectoryList	$directoryList,
		\Magento\Framework\Filesystem\Driver\File	$driverFile,
		\Magento\Store\Model\Config\StoreView	$storeView,
		\Magento\Framework\ShellInterface	$shell,
		UserCollection	$userCollection = null,
		Locale	$locale = null
	)

Parameters

\Magento\Framework\App\DeploymentConfig\Writer	$writer
\Magento\Framework\App\DeploymentConfig\Reader	$reader
\Magento\Framework\ObjectManagerInterface	$objectManager
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\App\Filesystem\DirectoryList	$directoryList
\Magento\Framework\Filesystem\Driver\File	$driverFile
\Magento\Store\Model\Config\StoreView	$storeView
\Magento\Framework\ShellInterface	$shell
UserCollection | null	$userCollection
Locale | null	$locale	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 122 of file Filesystem.php.

      {
        $this->writer = $writer;
        $this->reader = $reader;
        $this->objectManager = $objectManager;
        $this->filesystem = $filesystem;
        $this->directoryList = $directoryList;
        $this->driverFile = $driverFile;
        $this->storeView = $storeView;
        $this->shell = $shell;
        $this->userCollection = $userCollection ?: $this->objectManager->get(UserCollection::class);
        $this->locale = $locale ?: $this->objectManager->get(Locale::class);
        $this->functionCallPath =
            PHP_BINARY . ' -f ' . BP . DIRECTORY_SEPARATOR . 'bin' . DIRECTORY_SEPARATOR . 'magento ';
    }

Member Function Documentation

changePermissions()

changePermissions (   $directoryCodeList,   $dirPermissions,   $filePermissions  )

protected

Changes permissions for directories by their code.

Parameters

array	$directoryCodeList
int	$dirPermissions
int	$filePermissions

Returns

void

Deprecated:

100.0.6 As magento2 doesn't control indirectly the access permissions to the files and directories anymore. Access permissions to the files and directories are set during deploy Magento 2, directly after uploading code of Magento. Also it is possible to specify the value of inverse mask for setting access permissions to files and directories generated by Magento. http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html

Definition at line 326 of file Filesystem.php.

    {
        foreach ($directoryCodeList as $code) {
            $directoryPath = $this->directoryList->getPath($code);
            if ($this->driverFile->isExists($directoryPath)) {
                $this->filesystem->getDirectoryWrite($code)
                    ->changePermissionsRecursively('', $dirPermissions, $filePermissions);
            } else {
                $this->driverFile->createDirectory($directoryPath, $dirPermissions);
            }
        }
    }

cleanupFilesystem()

cleanupFilesystem

(

$directoryCodeList

)

Deletes specified directories by code

Parameters

array

$directoryCodeList

Returns

void

Definition at line 283 of file Filesystem.php.

    {
        $excludePatterns = ['#.htaccess#', '#deployed_version.txt#'];
        foreach ($directoryCodeList as $code) {
            if ($code == DirectoryList::STATIC_VIEW) {
                $directoryPath = $this->directoryList->getPath(DirectoryList::STATIC_VIEW);
                if ($this->driverFile->isExists($directoryPath)) {
                    $files = $this->driverFile->readDirectory($directoryPath);
                    foreach ($files as $file) {
                        foreach ($excludePatterns as $pattern) {
                            if (preg_match($pattern, $file)) {
                                continue 2;
                            }
                        }
                        if ($this->driverFile->isFile($file)) {
                            $this->driverFile->deleteFile($file);
                        } else {
                            $this->driverFile->deleteDirectory($file);
                        }
                    }
                }
            } else {
                $this->filesystem->getDirectoryWrite($code)
                    ->delete();
            }
        }
    }

compile()

compile ( OutputInterface  $output )

protected

Runs compiler

Parameters

OutputInterface

$output

Returns

void

Exceptions

LocalizedException

exec command is necessary for now to isolate the autoloaders in the compiler from the memory state of this process, which would prevent some classes from being generated

Todo:

eliminate exec

Definition at line 249 of file Filesystem.php.

    {
        $output->writeln('Starting compilation');
        $this->cleanupFilesystem(
            [
                DirectoryList::CACHE,
                DirectoryList::GENERATED_CODE,
                DirectoryList::GENERATED_METADATA,
            ]
        );
        $cmd = $this->functionCallPath . 'setup:di:compile';

        try {
            $execOutput = $this->shell->execute($cmd);
        } catch (LocalizedException $e) {
            $output->writeln('Something went wrong while compiling generated code. See the error log for details.');
            throw $e;
        }
        $output->writeln($execOutput);
        $output->writeln('Compilation complete');
    }

deployStaticContent()

deployStaticContent ( OutputInterface  $output )

protected

Deploy static content

Parameters

OutputInterface

$output

Returns

void

Exceptions

Todo:

eliminate exec

Definition at line 181 of file Filesystem.php.

      {
        $output->writeln('Starting deployment of static content');
        $cmd = $this->functionCallPath . 'setup:static-content:deploy -f '
            . implode(' ', $this->getUsedLocales());

        try {
            $execOutput = $this->shell->execute($cmd);
        } catch (LocalizedException $e) {
            $output->writeln('Something went wrong while deploying static content. See the error log for details.');
            throw $e;
        }
        $output->writeln($execOutput);
        $output->writeln('Deployment of static content complete');
    }

lockStaticResources()

lockStaticResources

(

)

Change permissions on static resources

Returns

void

Deprecated:

100.0.6 As magento2 doesn't control indirectly the access permissions to the files and directories anymore. Access permissions to the files and directories are set during deploy Magento 2, directly after uploading code of Magento. Also it is possible to specify the value of inverse mask for setting access permissions to files and directories generated by Magento. http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html

Definition at line 351 of file Filesystem.php.

    {
        // Lock /generated/code, /generated/metadata/ and /var/view_preprocessed directories
        $this->changePermissions(
            [
                DirectoryList::GENERATED_CODE,
                DirectoryList::GENERATED_METADATA,
                DirectoryList::TMP_MATERIALIZATION_DIR,
            ],
            self::PERMISSIONS_DIR,
            self::PERMISSIONS_FILE
        );
    }

regenerateStatic()

regenerateStatic

(

OutputInterface

$output

)

Regenerate static

Parameters

OutputInterface

$output

Returns

void

Definition at line 154 of file Filesystem.php.

      {
        // Сlear generated/code, generated/metadata/, var/view_preprocessed and pub/static directories
        $this->cleanupFilesystem(
            [
                DirectoryList::CACHE,
                DirectoryList::GENERATED_CODE,
                DirectoryList::GENERATED_METADATA,
                DirectoryList::TMP_MATERIALIZATION_DIR,
                DirectoryList::STATIC_VIEW
            ]
        );
        
        // Trigger code generation
        $this->compile($output);
        // Trigger static assets compilation and deployment
        $this->deployStaticContent($output);
    }

Field Documentation

DEFAULT_THEME

const DEFAULT_THEME = 'Magento/blank'

Default theme when no theme is stored in configuration

Definition at line 52 of file Filesystem.php.

PERMISSIONS_DIR

const PERMISSIONS_DIR = 0750

Directory access permissions

Deprecated:

As magento2 doesn't control indirectly the access permissions to the directories anymore. Access permissions to the directories are set during deploy Magento 2, directly after uploading code of Magento. Also it is possible to specify the value of inverse mask for setting access permissions to directories generated by Magento. http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html

Definition at line 47 of file Filesystem.php.

PERMISSIONS_FILE

const PERMISSIONS_FILE = 0640

File access permissions

Deprecated:

As magento2 doesn't control indirectly the access permissions to the files anymore. Access permissions to the files are set during deploy Magento 2, directly after uploading code of Magento. Also it is possible to specify the value of inverse mask for setting access permissions to files generated by Magento. http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html

Definition at line 35 of file Filesystem.php.

---

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

• vendor/magento/module-deploy/Model/Filesystem.php