LocallangArrayParser Class Reference

Inheritance diagram for LocallangArrayParser:

Public Member Functions
	__construct ()
	getParsedData ($sourcePath, $languageKey, $charset= '')

Protected Member Functions
	convertToXLIFF (array $LOCAL_LANG)
	createCsConvObject ()
	generateCacheFile ($sourcePath, $languageKey)
	generateCacheFileName ($sourcePath, $languageKey)
	getContentFromCacheFile ()
	isWithinWebRoot ($fileName)
	setCharsets ($languageKey, $charset)
	validateParameters ($sourcePath, $languageKey)

Protected Attributes
	$cacheFileName
	$csConvObj
	$hashSource
	$sourceCharset
	$targetCharset

Detailed Description

Parser for PHP locallang array.

Deprecated:

since TYPO3 CMS 7, this file will be removed in TYPO3 CMS 8. Please use XLF files for translation handling. Also note that the extension "extdeveval" has a converter from PHP and XML to XLF.

Definition at line 27 of file LocallangArrayParser.php.

Constructor & Destructor Documentation

__construct

(

)

Initializes the parser.

Deprecated:

since TYPO3 CMS 7, will be removed in TYPO3 CMS 8. Use xlf format for parsing translations

Definition at line 59 of file LocallangArrayParser.php.

References LocallangArrayParser\createCsConvObject(), and GeneralUtility\logDeprecatedFunction().

Member Function Documentation

convertToXLIFF ( array  $LOCAL_LANG )

protected

Converts the LOCAL_LANG array to XLIFF structure.

Parameters

array

$LOCAL_LANG

Returns

array

Definition at line 94 of file LocallangArrayParser.php.

Referenced by LocallangArrayParser\getParsedData().

createCsConvObject ( )

protected

Creates a character conversion object.

Returns

void

Definition at line 114 of file LocallangArrayParser.php.

References $GLOBALS, elseif, and GeneralUtility\makeInstance().

Referenced by LocallangArrayParser\__construct().

generateCacheFile (   $sourcePath,   $languageKey  )

protected

Generates the cache file.

Parameters

string	$sourcePath
string	$languageKey

Returns

array

Exceptions

\RuntimeException

Definition at line 133 of file LocallangArrayParser.php.

References PathUtility\stripPathSitePrefix(), and GeneralUtility\writeFileToTypo3tempDir().

Referenced by LocallangArrayParser\getParsedData().

generateCacheFileName (   $sourcePath,   $languageKey  )

protected

Generates the name of the cached file.

Parameters

string	$sourcePath
string	$languageKey

Returns

void

Definition at line 176 of file LocallangArrayParser.php.

References GeneralUtility\shortMD5(), and PathUtility\stripPathSitePrefix().

Referenced by LocallangArrayParser\getParsedData().

getContentFromCacheFile ( )

protected

Obtains the content from the cache file.

Returns

array

Definition at line 187 of file LocallangArrayParser.php.

Referenced by LocallangArrayParser\getParsedData().

getParsedData	(		$sourcePath,
			$languageKey,
			$charset = ''
	)

Returns parsed representation of PHP locallang file.

Parameters

string	$sourcePath	Source file path
string	$languageKey	Language key
string	$charset	Charset

Returns

array

Exceptions

\RuntimeException

Implements LocalizationParserInterface.

Definition at line 74 of file LocallangArrayParser.php.

References LocallangArrayParser\convertToXLIFF(), LocallangArrayParser\generateCacheFile(), LocallangArrayParser\generateCacheFileName(), LocallangArrayParser\getContentFromCacheFile(), LocallangArrayParser\setCharsets(), and LocallangArrayParser\validateParameters().

isWithinWebRoot (   $fileName )

protected

Checks if the file is within the web root.

Parameters

string

$fileName

Returns

bool

Definition at line 200 of file LocallangArrayParser.php.

References GeneralUtility\getFileAbsFileName().

Referenced by LocallangArrayParser\validateParameters().

setCharsets (   $languageKey,   $charset  )

protected

Sets character sets for the language key.

Parameters

string	$languageKey
string	$charset

Returns

void

Definition at line 212 of file LocallangArrayParser.php.

Referenced by LocallangArrayParser\getParsedData().

validateParameters (   $sourcePath,   $languageKey  )

protected

Validates parameters for the function.

Parameters

string	$sourcePath
string	$languageKey

Returns

void

Exceptions

\RuntimeException

Definition at line 230 of file LocallangArrayParser.php.

References LocallangArrayParser\isWithinWebRoot().

Referenced by LocallangArrayParser\getParsedData().

Member Data Documentation

$cacheFileName

protected

Definition at line 32 of file LocallangArrayParser.php.

$csConvObj

protected

Definition at line 37 of file LocallangArrayParser.php.

$hashSource

protected

Definition at line 42 of file LocallangArrayParser.php.

$sourceCharset

protected

Definition at line 47 of file LocallangArrayParser.php.

$targetCharset

protected

Definition at line 52 of file LocallangArrayParser.php.