FileManager Class Reference

Public Member Functions
	__construct (\Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Framework\App\Filesystem\DirectoryList $directoryList, \Magento\Framework\Filesystem\Driver\File $driverFile, \Magento\Translation\Model\Inline\File $translationFile=null)
	createTranslateConfigAsset ()
	getTranslationFileTimestamp ()
	getTranslationFilePath ()
	updateTranslationFileContent ($content)
	getTranslationFileVersion ()

Data Fields
const	TRANSLATION_CONFIG_FILE_NAME = 'Magento_Translation/js/i18n-config.js'

Protected Member Functions
	getTranslationFileFullPath ()

Detailed Description

A service for handling Translation config files

Definition at line 15 of file FileManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Framework\App\Filesystem\DirectoryList	$directoryList,
		\Magento\Framework\Filesystem\Driver\File	$driverFile,
		\Magento\Translation\Model\Inline\File	$translationFile = null
	)

Parameters

\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\App\Filesystem\DirectoryList	$directoryList
\Magento\Framework\Filesystem\Driver\File	$driverFile
TranslationFile	$translationFile

Definition at line 48 of file FileManager.php.

      {
        $this->assetRepo = $assetRepo;
        $this->directoryList = $directoryList;
        $this->driverFile = $driverFile;
        $this->translationFile = $translationFile ?: ObjectManager::getInstance()->get(TranslationFile::class);
    }

Member Function Documentation

createTranslateConfigAsset()

createTranslateConfigAsset

(

)

Create a view asset representing the requirejs config.config property for inline translation

Returns

\Magento\Framework\View\Asset\File

Definition at line 65 of file FileManager.php.

    {
        return $this->assetRepo->createArbitrary(
            $this->assetRepo->getStaticViewFileContext()->getPath() . '/' . self::TRANSLATION_CONFIG_FILE_NAME,
            ''
        );
    }

getTranslationFileFullPath()

getTranslationFileFullPath ( )

protected

Returns

string

Definition at line 92 of file FileManager.php.

    {
        return $this->directoryList->getPath(DirectoryList::STATIC_VIEW) .
        \DIRECTORY_SEPARATOR .
        $this->assetRepo->getStaticViewFileContext()->getPath() .
        \DIRECTORY_SEPARATOR .
        Js\Config::DICTIONARY_FILE_NAME;
    }

getTranslationFilePath()

getTranslationFilePath

(

)

Returns

string

Definition at line 104 of file FileManager.php.

    {
        return $this->assetRepo->getStaticViewFileContext()->getPath();
    }

getTranslationFileTimestamp()

getTranslationFileTimestamp

(

)

gets current js-translation.json timestamp

Returns

string|void

Definition at line 78 of file FileManager.php.

    {
        $translationFilePath = $this->getTranslationFileFullPath();
        if ($this->driverFile->isExists($translationFilePath)) {
            $statArray = $this->driverFile->stat($translationFilePath);
            if (array_key_exists('mtime', $statArray)) {
                return $statArray['mtime'];
            }
        }
    }

getTranslationFileVersion()

getTranslationFileVersion

(

)

Calculate translation file version hash.

Returns

string

Definition at line 129 of file FileManager.php.

    {
        $translationFile = $this->getTranslationFileFullPath();
        $translationFileHash = '';

        if ($this->driverFile->isExists($translationFile)) {
            $translationFileHash = sha1_file($translationFile);
        }

        return sha1($translationFileHash . $this->getTranslationFilePath());
    }

updateTranslationFileContent()

updateTranslationFileContent

(

$content

)

Parameters

string

$content

Returns

void

Definition at line 113 of file FileManager.php.

    {
        $translationDir = $this->directoryList->getPath(DirectoryList::STATIC_VIEW) .
            \DIRECTORY_SEPARATOR .
            $this->assetRepo->getStaticViewFileContext()->getPath();
        if (!$this->driverFile->isExists($this->getTranslationFileFullPath())) {
            $this->driverFile->createDirectory($translationDir);
        }
        $this->driverFile->filePutContents($this->getTranslationFileFullPath(), $content);
    }

Field Documentation

TRANSLATION_CONFIG_FILE_NAME

const TRANSLATION_CONFIG_FILE_NAME = 'Magento_Translation/js/i18n-config.js'

File name of RequireJs inline translation config

Definition at line 20 of file FileManager.php.

---

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

• vendor/magento/module-translation/Model/FileManager.php