Inheritance diagram for Translate:

Data Structures
class	InlineTest

Public Member Functions
	__construct (\Magento\Framework\View\DesignInterface $viewDesign, \Magento\Framework\Cache\FrontendInterface $cache, \Magento\Framework\View\FileSystem $viewFileSystem, \Magento\Framework\Module\ModuleList $moduleList, \Magento\Framework\Module\Dir\Reader $modulesReader, \Magento\Framework\App\ScopeResolverInterface $scopeResolver, \Magento\Framework\Translate\ResourceInterface $translate, \Magento\Framework\Locale\ResolverInterface $locale, \Magento\Framework\App\State $appState, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\App\RequestInterface $request, \Magento\Framework\File\Csv $csvParser, \Magento\Framework\App\Language\Dictionary $packDictionary, DriverInterface $fileDriver=null)

	loadData ($area=null, $forceReload=false)

	getData ()

	getLocale ()

	setLocale ($locale)

	getTheme ()

Data Fields
const	CONFIG_AREA_KEY = 'area'

const	CONFIG_LOCALE_KEY = 'locale'

const	CONFIG_SCOPE_KEY = 'scope'

const	CONFIG_THEME_KEY = 'theme'

const	CONFIG_MODULE_KEY = 'module'

Data Fields inherited from TranslateInterface
const	DEFAULT_STRING = 'Translate String'

Protected Member Functions
	setConfig ($config)

	getScope ()

	getConfig ($key)

	getControllerModuleName ()

	_loadModuleTranslation ()

	loadModuleTranslationByModulesList (array $modules)

	_addData ($data)

	_loadThemeTranslation ()

	_loadPackTranslation ()

	_loadDbTranslation ()

	_getModuleTranslationFile ($moduleName, $locale)

	_getThemeTranslationFile ($locale)

	_getFileData ($file)

	getCacheId ()

	_loadCache ()

	_saveCache ()

Protected Attributes
	$_localeCode

	$_config

	$_cacheId

	$_data = []

	$_viewDesign

	$_cache

	$_viewFileSystem

	$_moduleList

	$_modulesReader

	$_scopeResolver

	$_translateResource

	$_locale

	$_appState

	$directory

	$request

	$_csvParser

	$packDictionary

Detailed Description

Translate library

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 20 of file Translate.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\DesignInterface	$viewDesign,
		\Magento\Framework\Cache\FrontendInterface	$cache,
		\Magento\Framework\View\FileSystem	$viewFileSystem,
		\Magento\Framework\Module\ModuleList	$moduleList,
		\Magento\Framework\Module\Dir\Reader	$modulesReader,
		\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\Translate\ResourceInterface	$translate,
		\Magento\Framework\Locale\ResolverInterface	$locale,
		\Magento\Framework\App\State	$appState,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\App\RequestInterface	$request,
		\Magento\Framework\File\Csv	$csvParser,
		\Magento\Framework\App\Language\Dictionary	$packDictionary,
		DriverInterface	$fileDriver = `null`
	)

Parameters

\Magento\Framework\View\DesignInterface	$viewDesign
\Magento\Framework\Cache\FrontendInterface	$cache
\Magento\Framework\View\FileSystem	$viewFileSystem
\Magento\Framework\Module\ModuleList	$moduleList
\Magento\Framework\Module\Dir\Reader	$modulesReader
\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
\Magento\Framework\Translate\ResourceInterface	$translate
\Magento\Framework\Locale\ResolverInterface	$locale
\Magento\Framework\App\State	$appState
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\App\RequestInterface	$request
\Magento\Framework\File\Csv	$csvParser
\Magento\Framework\App\Language\Dictionary	$packDictionary
DriverInterface \| null	$fileDriver	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 149 of file Translate.php.

       {
         $this->_viewDesign = $viewDesign;
         $this->_cache = $cache;
         $this->_viewFileSystem = $viewFileSystem;
         $this->_moduleList = $moduleList;
         $this->_modulesReader = $modulesReader;
         $this->_scopeResolver = $scopeResolver;
         $this->_translateResource = $translate;
         $this->_locale = $locale;
         $this->_appState = $appState;
         $this->request = $request;
         $this->directory = $filesystem->getDirectoryRead(DirectoryList::ROOT);
         $this->_csvParser = $csvParser;
         $this->packDictionary = $packDictionary;
         $this->fileDriver = $fileDriver
             ?? ObjectManager::getInstance()->get(File::class);
 
         $this->_config = [
             self::CONFIG_AREA_KEY => null,
             self::CONFIG_LOCALE_KEY => null,
             self::CONFIG_SCOPE_KEY => null,
             self::CONFIG_THEME_KEY => null,
             self::CONFIG_MODULE_KEY => null,
         ];
     }

Member Function Documentation

◆ _addData()

_addData ( $data )

protected

Adding translation data

Parameters

array $data

Returns: $this

Definition at line 323 of file Translate.php.

     {
         foreach ($data as $key => $value) {
             if ($key === $value) {
                 if (isset($this->_data[$key])) {
                     unset($this->_data[$key]);
                 }
                 continue;
             }
 
             $key = str_replace('""', '"', $key);
             $value = str_replace('""', '"', $value);
 
             $this->_data[$key] = $value;
         }
         return $this;
     }

◆ _getFileData()

_getFileData ( $file )

protected

Retrieve data from file

Parameters

string $file

Returns: array

Definition at line 412 of file Translate.php.

     {
         $data = [];
         if ($this->fileDriver->isExists($file)) {
             $this->_csvParser->setDelimiter(',');
             $data = $this->_csvParser->getDataPairs($file);
         }
         return $data;
     }

◆ _getModuleTranslationFile()

_getModuleTranslationFile	(	$moduleName,
		$locale
	)

protected

Retrieve translation file for module

Parameters

string	$moduleName
string	$locale

Returns: string

Definition at line 385 of file Translate.php.

     {
         $file = $this->_modulesReader->getModuleDir(Module\Dir::MODULE_I18N_DIR, $moduleName);
         $file .= '/' . $locale . '.csv';
         return $file;
     }

◆ _getThemeTranslationFile()

_getThemeTranslationFile ( $locale )

protected

Retrieve translation file for theme

Parameters

string $locale

Returns: string

Definition at line 398 of file Translate.php.

     {
         return $this->_viewFileSystem->getLocaleFileName(
             'i18n' . '/' . $locale . '.csv',
             $this->_config
         );
     }

◆ _loadCache()

_loadCache ( )

protected

Loading data cache

Returns: array|bool

Definition at line 498 of file Translate.php.

     {
         $data = $this->_cache->load($this->getCacheId());
         if ($data) {
             $data = $this->getSerializer()->unserialize($data);
         }
         return $data;
     }

◆ _loadDbTranslation()

_loadDbTranslation ( )

protected

Loading current translation from DB

Returns: $this

Definition at line 371 of file Translate.php.

     {
         $data = $this->_translateResource->getTranslationArray(null, $this->getLocale());
         $this->_addData(array_map('htmlspecialchars_decode', $data));
         return $this;
     }

◆ _loadModuleTranslation()

_loadModuleTranslation ( )

protected

Load data from module translation files

Returns: $this

Definition at line 292 of file Translate.php.

     {
         $currentModule = $this->getControllerModuleName();
         $allModulesExceptCurrent = array_diff($this->_moduleList->getNames(), [$currentModule]);
 
         $this->loadModuleTranslationByModulesList($allModulesExceptCurrent);
         $this->loadModuleTranslationByModulesList([$currentModule]);
         return $this;
     }

◆ _loadPackTranslation()

_loadPackTranslation ( )

protected

Load translation dictionary from language packages

Returns: void

Definition at line 360 of file Translate.php.

     {
         $data = $this->packDictionary->getDictionary($this->getLocale());
         $this->_addData($data);
     }

◆ _loadThemeTranslation()

_loadThemeTranslation ( )

protected

Load current theme translation

Returns: $this

Definition at line 346 of file Translate.php.

     {
         $file = $this->_getThemeTranslationFile($this->getLocale());
         if ($file) {
             $this->_addData($this->_getFileData($file));
         }
         return $this;
     }

◆ _saveCache()

_saveCache ( )

protected

Saving data cache

Returns: $this

Definition at line 512 of file Translate.php.

     {
         $this->_cache->save($this->getSerializer()->serialize($this->getData()), $this->getCacheId(), [], false);
         return $this;
     }

◆ getCacheId()

getCacheId ( )

protected

Retrieve cache identifier

Returns: string

Definition at line 480 of file Translate.php.

     {
         $_cacheId = \Magento\Framework\App\Cache\Type\Translate::TYPE_IDENTIFIER;
         $_cacheId .= '_' . $this->_config[self::CONFIG_LOCALE_KEY];
         $_cacheId .= '_' . $this->_config[self::CONFIG_AREA_KEY];
         $_cacheId .= '_' . $this->_config[self::CONFIG_SCOPE_KEY];
         $_cacheId .= '_' . $this->_config[self::CONFIG_THEME_KEY];
         $_cacheId .= '_' . $this->_config[self::CONFIG_MODULE_KEY];
 
         $this->_cacheId = $_cacheId;
         return $_cacheId;
     }

◆ getConfig()

getConfig ( $key )

protected

Retrieve config value by key

Parameters

string $key

Returns: mixed

Definition at line 270 of file Translate.php.

     {
         if (isset($this->_config[$key])) {
             return $this->_config[$key];
         }
         return null;
     }

◆ getControllerModuleName()

getControllerModuleName ( )

protected

Retrieve name of the current module

Returns: mixed

Definition at line 282 of file Translate.php.

     {
         return $this->request->getControllerModule();
     }

◆ getData()

getData ( )

Retrieve translation data

Returns: array

Implements TranslateInterface.

Definition at line 427 of file Translate.php.

     {
         if ($this->_data === null) {
             return [];
         }
         return $this->_data;
     }

◆ getLocale()

getLocale ( )

Retrieve locale

Returns: string

Implements TranslateInterface.

Definition at line 440 of file Translate.php.

     {
         if (null === $this->_localeCode) {
             $this->_localeCode = $this->_locale->getLocale();
         }
         return $this->_localeCode;
     }

◆ getScope()

getScope ( )

protected

Retrieve scope code

Returns: string

Definition at line 258 of file Translate.php.

     {
         $scope = ($this->getConfig(self::CONFIG_AREA_KEY) === 'adminhtml') ? 'admin' : null;
         return $this->_scopeResolver->getScope($scope)->getCode();
     }

◆ getTheme()

getTheme ( )

Retrieve theme code

Returns: string

Implements TranslateInterface.

Definition at line 466 of file Translate.php.

     {
         $theme = $this->request->getParam(self::CONFIG_THEME_KEY);
         if (empty($theme)) {
             return self::CONFIG_THEME_KEY . $this->getConfig(self::CONFIG_THEME_KEY);
         }
         return self::CONFIG_THEME_KEY . $theme['theme_title'];
     }

◆ loadData()

loadData	(	$area = `null`,
		$forceReload = `false`
	)

Initialize translation data

Parameters

string \| null	$area
bool	$forceReload

Returns: $this

Implements TranslateInterface.

Definition at line 197 of file Translate.php.

     {
         $this->_data = [];
         if ($area === null) {
             $area = $this->_appState->getAreaCode();
         }
         $this->setConfig(
             [
                 self::CONFIG_AREA_KEY => $area,
             ]
         );
 
         if (!$forceReload) {
             $data = $this->_loadCache();
             if (false !== $data) {
                 $this->_data = $data;
                 return $this;
             }
         }
 
         $this->_loadModuleTranslation();
         $this->_loadPackTranslation();
         $this->_loadThemeTranslation();
         $this->_loadDbTranslation();
 
         if (!$forceReload) {
             $this->_saveCache();
         }
 
         return $this;
     }

◆ loadModuleTranslationByModulesList()

loadModuleTranslationByModulesList ( array $modules )

protected

Load data from module translation files by list of modules

Parameters

array $modules

Returns: $this

Definition at line 308 of file Translate.php.

     {
         foreach ($modules as $module) {
             $moduleFilePath = $this->_getModuleTranslationFile($module, $this->getLocale());
             $this->_addData($this->_getFileData($moduleFilePath));
         }
         return $this;
     }

◆ setConfig()

setConfig ( $config )

protected

Initialize configuration

Parameters

array $config

Returns: $this

Definition at line 235 of file Translate.php.

     {
         $this->_config = $config;
         if (!isset($this->_config[self::CONFIG_LOCALE_KEY])) {
             $this->_config[self::CONFIG_LOCALE_KEY] = $this->getLocale();
         }
         if (!isset($this->_config[self::CONFIG_SCOPE_KEY])) {
             $this->_config[self::CONFIG_SCOPE_KEY] = $this->getScope();
         }
         if (!isset($this->_config[self::CONFIG_THEME_KEY])) {
             $this->_config[self::CONFIG_THEME_KEY] = $this->_viewDesign->getDesignTheme()->getThemePath();
         }
         if (!isset($this->_config[self::CONFIG_MODULE_KEY])) {
             $this->_config[self::CONFIG_MODULE_KEY] = $this->getControllerModuleName();
         }
         return $this;
     }

◆ setLocale()

setLocale ( $locale )

Set locale

Parameters

string $locale

Returns: \Magento\Framework\TranslateInterface

Implements TranslateInterface.

Definition at line 454 of file Translate.php.

     {
         $this->_localeCode = $locale;
         $this->_config[self::CONFIG_LOCALE_KEY] = $locale;
         return $this;
     }

Field Documentation

◆ $_appState

$_appState

protected

Definition at line 99 of file Translate.php.

◆ $_cache

$_cache

protected

Definition at line 64 of file Translate.php.

◆ $_cacheId

$_cacheId

protected

Definition at line 47 of file Translate.php.

◆ $_config

$_config

protected

Definition at line 40 of file Translate.php.

◆ $_csvParser

$_csvParser

protected

Definition at line 114 of file Translate.php.

◆ $_data

$_data = []

protected

Definition at line 54 of file Translate.php.

◆ $_locale

$_locale

protected

Definition at line 94 of file Translate.php.

◆ $_localeCode

$_localeCode

protected

Definition at line 33 of file Translate.php.

◆ $_moduleList

$_moduleList

protected

Definition at line 74 of file Translate.php.

◆ $_modulesReader

$_modulesReader

protected

Definition at line 79 of file Translate.php.

◆ $_scopeResolver

$_scopeResolver

protected

Definition at line 84 of file Translate.php.

◆ $_translateResource

$_translateResource

protected

Definition at line 89 of file Translate.php.

◆ $_viewDesign

$_viewDesign

protected

Definition at line 59 of file Translate.php.

◆ $_viewFileSystem

$_viewFileSystem

protected

Definition at line 69 of file Translate.php.

◆ $directory

$directory

protected

Definition at line 104 of file Translate.php.

◆ $packDictionary

$packDictionary

protected

Definition at line 119 of file Translate.php.

◆ $request

$request

protected

Definition at line 109 of file Translate.php.

◆ CONFIG_AREA_KEY

const CONFIG_AREA_KEY = 'area'

Definition at line 22 of file Translate.php.

◆ CONFIG_LOCALE_KEY

const CONFIG_LOCALE_KEY = 'locale'

Definition at line 23 of file Translate.php.

◆ CONFIG_MODULE_KEY

const CONFIG_MODULE_KEY = 'module'

Definition at line 26 of file Translate.php.

◆ CONFIG_SCOPE_KEY

const CONFIG_SCOPE_KEY = 'scope'

Definition at line 24 of file Translate.php.

◆ CONFIG_THEME_KEY

const CONFIG_THEME_KEY = 'theme'

Definition at line 25 of file Translate.php.

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

vendor/magento/framework/Translate.php

Data Structures

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addData()

◆ _getFileData()

◆ _getModuleTranslationFile()

◆ _getThemeTranslationFile()

◆ _loadCache()

◆ _loadDbTranslation()

◆ _loadModuleTranslation()

◆ _loadPackTranslation()

◆ _loadThemeTranslation()

◆ _saveCache()

◆ getCacheId()

◆ getConfig()

◆ getControllerModuleName()

◆ getData()

◆ getLocale()

◆ getScope()

◆ getTheme()

◆ loadData()

◆ loadModuleTranslationByModulesList()

◆ setConfig()

◆ setLocale()

Field Documentation

◆ $_appState

◆ $_cache

◆ $_cacheId

◆ $_config

◆ $_csvParser

◆ $_data

◆ $_locale

◆ $_localeCode

◆ $_moduleList

◆ $_modulesReader

◆ $_scopeResolver

◆ $_translateResource

◆ $_viewDesign

◆ $_viewFileSystem

◆ $directory

◆ $packDictionary

◆ $request

◆ CONFIG_AREA_KEY

◆ CONFIG_LOCALE_KEY

◆ CONFIG_MODULE_KEY

◆ CONFIG_SCOPE_KEY

◆ CONFIG_THEME_KEY