language Class Reference

List of all members.

Public Member Functions
	init ($lang, $altPath='')
	Initializes the backend language.
	addModuleLabels ($arr, $prefix)
	Adds labels and image references from the backend modules to the internal moduleLabels array.
	hscAndCharConv ($lStr, $hsc)
	Will htmlspecialchar() the input string and before that any charset conversion will also have taken place if needed (see init()) Used to pipe language labels through just before they are returned.
	makeEntities ($str)
	Will convert the input strings special chars (all above 127) to entities.
	JScharCode ($str)
	Converts the input string to a JavaScript function returning the same string, but charset-safe.
	getLL ($index, $hsc=0)
	Returns the label with key $index form the globally loaded $LOCAL_LANG array.
	getLLL ($index, $LOCAL_LANG, $hsc=0)
	Works like ->getLL() but takes the $LOCAL_LANG array used as the second argument instead of using the global array.
	sL ($input, $hsc=0)
	splitLabel function Historically labels were exploded by '|' and each part would correspond to the translation of the language found at the same 'index' in the TYPO3_languages constant.
	loadSingleTableDescription ($table)
	Loading $TCA_DESCR[$table]['columns'] with content from locallang files as defined in $TCA_DESCR[$table]['refs'] $TCA_DESCR is a global var.
	includeLLFile ($fileRef, $setGlobal=1, $mergeLocalOntoDefault=0)
	Includes locallang file (and possibly additional localized version if configured for) Read language labels will be merged with $LOCAL_LANG (if $setGlobal=1).
	readLLfile ($fileRef)
	Includes a locallang file and returns the $LOCAL_LANG array found inside.
	readLLXMLfile ($fileRef, $langKey)
	Includes a locallang-xml file and returns the $LOCAL_LANG array.
	localizedFileRef ($fileRef)
	Returns localized fileRef (.[langkey].php).
Public Attributes
	$lang = 'default'
	$langSplit = 'default'
	$charSet = 'iso-8859-1'
	$charSetArray = array()
	$typo3_help_url
	$moduleLabels = Array()
	$langSplitIndex = 0
	$LL_files_cache = array()
	$LL_labels_cache = array()
	$origCharSet = ''
	$csConvObj

---

Member Function Documentation

language::addModuleLabels (  $  arr, $  prefix )

Adds labels and image references from the backend modules to the internal moduleLabels array. Parameters: array  Array with references to module labels, keys: ['labels']['tablabel'], ['labels']['tabdescr'], ['tabs']['tab'] string  Module name prefix Returns: void See also: t3lib_loadModules Definition at line 173 of file lang.php. { if (is_array($arr)) { reset($arr); while(list($k,$larr)=each($arr)) { if (!isset($this->moduleLabels[$k])) { $this->moduleLabels[$k]=array(); } if (is_array($larr)) { reset($larr); while(list($l,$v)=each($larr)) { $this->moduleLabels[$k][$prefix.$l]=$v; } } } } }

language::getLL (  $  index, $  hsc = 0 )

Returns the label with key $index form the globally loaded $LOCAL_LANG array. Mostly used from modules with only one LOCAL_LANG file loaded into the global space. Parameters: string  Label key boolean  If set, the return value is htmlspecialchar'ed Returns: string Definition at line 250 of file lang.php. { // Get Local Language if (strcmp($GLOBALS['LOCAL_LANG'][$this->lang][$index],'')) { return $this->hscAndCharConv($GLOBALS['LOCAL_LANG'][$this->lang][$index], $hsc); // Returns local label if not blank. } else { return $this->hscAndCharConv($GLOBALS['LOCAL_LANG']['default'][$index], $hsc); // Returns default label } }

language::getLLL (  $  index, $  LOCAL_LANG, $  hsc = 0 )

Works like ->getLL() but takes the $LOCAL_LANG array used as the second argument instead of using the global array. Parameters: string  Label key array  $LOCAL_LANG array to get label key from boolean  If set, the return value is htmlspecialchar'ed Returns: string Definition at line 267 of file lang.php. { // Get Local Language if (strcmp($LOCAL_LANG[$this->lang][$index],'')) { return $this->hscAndCharConv($LOCAL_LANG[$this->lang][$index], $hsc); // Returns local label if not blank. } else { return $this->hscAndCharConv($LOCAL_LANG['default'][$index], $hsc); // Returns default label } }

language::hscAndCharConv (  $  lStr, $  hsc )

Will htmlspecialchar() the input string and before that any charset conversion will also have taken place if needed (see init()) Used to pipe language labels through just before they are returned. Parameters: string  The string to process boolean  If set, then the string is htmlspecialchars()'ed Returns: string The processed string See also: init() Definition at line 199 of file lang.php. { $lStr = $hsc ? htmlspecialchars($lStr) : $lStr; if ($this->origCharSet) { $lStr = $this->csConvObj->conv($lStr,$this->origCharSet,$this->charSet,1); } return $lStr; }

language::includeLLFile (  $  fileRef, $  setGlobal = 1, $  mergeLocalOntoDefault = 0 )

Includes locallang file (and possibly additional localized version if configured for) Read language labels will be merged with $LOCAL_LANG (if $setGlobal=1). Parameters: string  $fileRef is a file-reference (see t3lib_div::getFileAbsFileName) boolean  Setting in global variable $LOCAL_LANG (or returning the variable) boolean  If $mergeLocalOntoDefault is set the local part of the $LOCAL_LANG array is merged onto the default part (if the local part exists) and the local part is unset. Returns: mixed If $setGlobal is true the LL-files will set the $LOCAL_LANG in the global scope. Otherwise the $LOCAL_LANG array is returned from function Definition at line 383 of file lang.php. References $LOCAL_LANG. { // Configure for global flag: if ($setGlobal) { global $LOCAL_LANG; } // Get default file: $llang = $this->readLLfile($fileRef); if (count($llang)) { $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$llang); // Localized addition? $lFileRef = $this->localizedFileRef($fileRef); if ($lFileRef && (string)$LOCAL_LANG[$this->lang]=='EXT') { $llang = $this->readLLfile($lFileRef); $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$llang); } // Overriding file? if (isset($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$fileRef])) { $ORarray = $this->readLLfile($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$fileRef]); $LOCAL_LANG = t3lib_div::array_merge_recursive_overrule($LOCAL_LANG,$ORarray); } // Merge local onto default: if ($mergeLocalOntoDefault && strcmp($this->lang,'default') && is_array($LOCAL_LANG[$this->lang]) && is_array($LOCAL_LANG['default'])) { $LOCAL_LANG['default'] = array_merge($LOCAL_LANG['default'],$LOCAL_LANG[$this->lang]); // array_merge can be used so far the keys are not numeric - which we assume they are not... unset($LOCAL_LANG[$this->lang]); } } // Return value if not global is set. if (!$setGlobal) { return $LOCAL_LANG; } }

language::init (  $  lang, $  altPath = '' )

Initializes the backend language. This is for example done in typo3/template.php with lines like these: require (PATH_typo3.'sysext/lang/lang.php'); $LANG = t3lib_div::makeInstance('language'); $LANG->init($BE_USER->uc['lang']); Parameters: string  The language key (two character string from backend users profile) string  IGNORE. Not used. Returns: void Definition at line 128 of file lang.php. References typo3PrintError(). { // Initialize the conversion object: $this->csConvObj = t3lib_div::makeInstance('t3lib_cs'); $this->charSetArray = $this->csConvObj->charSetArray; // Internally setting the list of TYPO3 backend languages. $this->langSplit=TYPO3_languages; // Finding the requested language in this list based on the $lang key being inputted to this function. $ls = explode('|',$this->langSplit); while(list($i,$v)=each($ls)) { if ($v==$lang) { // Language is found. Configure it: $this->langSplitIndex=$i; // The index of the language as found in the TYPO3_languages list $this->lang = $lang; // The current language key if ($this->helpUrlArray[$this->lang]) $this->typo3_help_url=$this->helpUrlArray[$this->lang]; // The help URL if different from the default. if ($this->charSetArray[$this->lang]) $this->charSet=$this->charSetArray[$this->lang]; // The charset if different from the default. } } // If a forced charset is used and different from the charset otherwise used: if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] && $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']!=$this->charSet) { // Set the forced charset: $this->origCharSet = $this->charSet; $this->charSet = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset']; if ($this->charSet!='utf-8' && !$this->csConvObj->initCharset($this->charSet)) { t3lib_BEfunc::typo3PrintError ('The forced character set "'.$this->charSet.'" was not found in t3lib/csconvtbl/','Forced charset not found'); exit; } if ($this->origCharSet!='utf-8' && !$this->csConvObj->initCharset($this->origCharSet)) { t3lib_BEfunc::typo3PrintError ('The original character set "'.$this->origCharSet.'" was not found in t3lib/csconvtbl/','Forced charset not found'); exit; } } }

language::JScharCode (  $  str  )

Converts the input string to a JavaScript function returning the same string, but charset-safe. Used for confirm and alert boxes where we must make sure that any string content does not break the script AND want to make sure the charset is preserved. Originally I used the JS function unescape() in combination with PHP function rawurlencode() in order to pass strings in a safe way. This could still be done for iso-8859-1 charsets but now I have applied the same method here for all charsets. Parameters: string  Input string, encoded with $this->charSet Returns: string Output string, a JavaScript function: "String.fromCharCode(......)" Definition at line 231 of file lang.php. { // Convert string to UTF-8: if ($this->charSet!='utf-8') $str = $this->csConvObj->utf8_encode($str,$this->charSet); // Convert the UTF-8 string into a array of char numbers: $nArr = $this->csConvObj->utf8_to_numberarray($str); return 'String.fromCharCode('.implode(',',$nArr).')'; }

language::loadSingleTableDescription (  $  table  )

Loading $TCA_DESCR[$table]['columns'] with content from locallang files as defined in $TCA_DESCR[$table]['refs'] $TCA_DESCR is a global var. Parameters: string  Table name found as key in global array $TCA_DESCR Returns: void Definition at line 331 of file lang.php. References $LOCAL_LANG, and table(). { global $TCA_DESCR; if (is_array($TCA_DESCR[$table]) && !isset($TCA_DESCR[$table]['columns']) && is_array($TCA_DESCR[$table]['refs'])) { // First the 'table' cannot already be loaded in [columns] and secondly there must be a references to locallang files available in [refs] // Init $TCA_DESCR for $table-key $TCA_DESCR[$table]['columns']=array(); // Get local-lang for each file in $TCA_DESCR[$table]['refs'] as they are ordered. foreach ($TCA_DESCR[$table]['refs'] as $llfile) { $LOCAL_LANG = $this->includeLLFile($llfile,0,1); // Traverse all keys if (is_array($LOCAL_LANG['default'])) { foreach($LOCAL_LANG['default'] as $lkey => $lVal) { // exploding by '.': // 0 => fieldname, // 1 => type from (alttitle,description,details,syntax,image_descr,image,seeAlso), // 2 => special instruction, see switch construct $kParts = explode('.',$lkey); // Detecting 'hidden' labels, converting to normal fieldname if ($kParts[0]=='_') $kParts[0]=''; if (substr($kParts[0],0,1)=='_') { $kParts[0] = substr($kParts[0],1); } // Add label: switch((string)$kParts[2]) { case '+': // adding $TCA_DESCR[$table]['columns'][$kParts[0]][$kParts[1]].= chr(10).$lVal; break; default: // Substituting: $TCA_DESCR[$table]['columns'][$kParts[0]][$kParts[1]] = $lVal; break; } } } } } }

language::localizedFileRef (  $  fileRef  )

Returns localized fileRef (.[langkey].php). Parameters: string  Filename/path of a 'locallang.php' file Returns: string Input filename with a '.[lang-key].php' ending added if $this->lang is not 'default' Definition at line 548 of file lang.php. { if ($this->lang!='default' && substr($fileRef,-4)=='.php') { return substr($fileRef,0,-4).'.'.$this->lang.'.php'; } }

language::makeEntities (  $  str  )

Will convert the input strings special chars (all above 127) to entities. The string is expected to be encoded in the charset, $this->charSet This function is used to create strings that can be used in the Click Menu (Context Sensitive Menus). The reason is that the values that are dynamically written into the layer is decoded as iso-8859-1 no matter what charset is used in the document otherwise (only MSIE, Mozilla is OK). So by converting we by-pass this problem. Parameters: string  Input string Returns: string Output string Definition at line 214 of file lang.php. { // Convert string to UTF-8: if ($this->charSet!='utf-8') $str = $this->csConvObj->utf8_encode($str,$this->charSet); // Convert string back again, but using the full entity conversion: $str = $this->csConvObj->utf8_to_entities($str); return $str; }

language::readLLfile (  $  fileRef  )

Includes a locallang file and returns the $LOCAL_LANG array found inside. Parameters: string  Input is a file-reference (see t3lib_div::getFileAbsFileName) which, if exists, is included. That file is expected to be a 'local_lang' file containing a $LOCAL_LANG array. Returns: array Value of $LOCAL_LANG found in the included file. If that array is found it's returned. Otherwise an empty array Definition at line 428 of file lang.php. References $LOCAL_LANG. { $file = t3lib_div::getFileAbsFileName($fileRef); if ($file) { $baseFile = ereg_replace('\.(php|xml)$', '', $file); if (@is_file($baseFile.'.xml')) { $LOCAL_LANG = $this->readLLXMLfile($baseFile.'.xml', $this->lang); } elseif (@is_file($baseFile.'.php')) { include($baseFile.'.php'); } else die('Filereference, "'.$file.'", not found!'); } return is_array($LOCAL_LANG)?$LOCAL_LANG:array(); }

language::readLLXMLfile (  $  fileRef, $  langKey )

Includes a locallang-xml file and returns the $LOCAL_LANG array. Parameters: string  Absolute reference to locallang-XML file string  TYPO3 language key, eg. "dk" or "de" or "default" Returns: array LOCAL_LANG array in return. Definition at line 449 of file lang.php. References $LOCAL_LANG, and PATH_site. { if (@is_file($fileRef) && $langKey) { // Set charset: $origCharset = $this->csConvObj->parse_charset($this->csConvObj->charSetArray[$langKey] ? $this->csConvObj->charSetArray[$langKey] : 'iso-8859-1'); // Cache file name: $hashSource = substr($fileRef,strlen(PATH_site)).'|'.date('d-m-Y H:i:s',filemtime($fileRef)); $cacheFileName = PATH_site.'typo3temp/llxml/'. #str_replace('_','',ereg_replace('^.*\/','',dirname($fileRef))). #'_'.basename($fileRef). substr(basename($fileRef),10,15). '_'.t3lib_div::shortMD5($hashSource).'.'.$langKey.'.'.$origCharset.'.cache'; // Check if cache file exists... if (!@is_file($cacheFileName)) { // ... if it doesn't, create content and write it: // Read XML, parse it. $xmlString = t3lib_div::getUrl($fileRef); $xmlContent = t3lib_div::xml2array($xmlString); // Set default LOCAL_LANG array content: $LOCAL_LANG = array(); $LOCAL_LANG['default'] = $xmlContent['data']['default']; // Specific language, convert from utf-8 to backend language charset: // NOTICE: Converting from utf-8 back to "native" language may be a temporary solution until we can totally discard "locallang.php" files altogether (and use utf-8 for everything). But doing this conversion is the quickest way to migrate now and the source is in utf-8 anyway which is the main point. if ($langKey!='default') { $LOCAL_LANG[$langKey] = $xmlContent['data'][$langKey]; // Checking if charset should be converted. if (is_array($LOCAL_LANG[$langKey]) && $origCharset!='utf-8') { foreach($LOCAL_LANG[$langKey] as $labelKey => $labelValue) { $LOCAL_LANG[$langKey][$labelKey] = $this->csConvObj->utf8_decode($labelValue,$origCharset); } } } // Cache the content now: $serContent = array('origFile'=>$hashSource, 'LOCAL_LANG'=>$LOCAL_LANG); $res = t3lib_div::writeFileToTypo3tempDir($cacheFileName, serialize($serContent)); if ($res) die('ERROR: '.$res); } else { // Get content from cache: $serContent = unserialize(t3lib_div::getUrl($cacheFileName)); $LOCAL_LANG = $serContent['LOCAL_LANG']; } // Checking for EXTERNAL file for non-default language: if ($langKey!='default' && is_string($LOCAL_LANG[$langKey]) && strlen($LOCAL_LANG[$langKey])) { // Look for localized file: $localized_file = t3lib_div::getFileAbsFileName($LOCAL_LANG[$langKey]); if ($localized_file && @is_file($localized_file)) { // Cache file name: $hashSource = substr($localized_file,strlen(PATH_site)).'|'.date('d-m-Y H:i:s',filemtime($localized_file)); $cacheFileName = PATH_site.'typo3temp/llxml/ext_'. substr(basename($localized_file),10,15). '_'.t3lib_div::shortMD5($hashSource).'.'.$langKey.'.'.$origCharset.'.cache'; // Check if cache file exists... if (!@is_file($cacheFileName)) { // ... if it doesn't, create content and write it: // Read and parse XML content: $local_xmlString = t3lib_div::getUrl($localized_file); $local_xmlContent = t3lib_div::xml2array($local_xmlString); $LOCAL_LANG[$langKey] = is_array($local_xmlContent['data'][$langKey]) ? $local_xmlContent['data'][$langKey] : array(); // Checking if charset should be converted. if (is_array($LOCAL_LANG[$langKey]) && $origCharset!='utf-8') { foreach($LOCAL_LANG[$langKey] as $labelKey => $labelValue) { $LOCAL_LANG[$langKey][$labelKey] = $this->csConvObj->utf8_decode($labelValue,$origCharset); } } // Cache the content now: $serContent = array('extlang'=>$langKey, 'origFile'=>$LOCAL_LANG[$langKey], 'EXT_DATA'=>$LOCAL_LANG[$langKey]); $res = t3lib_div::writeFileToTypo3tempDir($cacheFileName, serialize($serContent)); if ($res) die('ERROR: '.$res); } else { // Get content from cache: $serContent = unserialize(t3lib_div::getUrl($cacheFileName)); $LOCAL_LANG[$langKey] = $serContent['EXT_DATA']; } } } return $LOCAL_LANG; } }

language::sL (  $  input, $  hsc = 0 )

splitLabel function Historically labels were exploded by '|' and each part would correspond to the translation of the language found at the same 'index' in the TYPO3_languages constant. Today all translations are based on $LOCAL_LANG variables. 'language-splitted' labels can therefore refer to a local-lang file + index instead! It's highly recommended to use the 'local_lang' method (and thereby it's highly depreciated to use 'language-splitted' label strings) Refer to 'Inside TYPO3' for more details Parameters: string  Label key/reference boolean  If set, the return value is htmlspecialchar'ed Returns: string Definition at line 287 of file lang.php. References $out. { if (strcmp(substr($input,0,4),'LLL:')) { // Using obsolete 'language-splitted' labels: $t = explode('|',$input); $out = $t[$this->langSplitIndex] ? $t[$this->langSplitIndex] : $t[0]; return $this->hscAndCharConv($out, $hsc); } else { // LOCAL_LANG: if (!isset($this->LL_labels_cache[$this->lang][$input])) { // If cached label $restStr = trim(substr($input,4)); $extPrfx=''; if (!strcmp(substr($restStr,0,4),'EXT:')) { // ll-file refered to is found in an extension. $restStr = trim(substr($restStr,4)); $extPrfx='EXT:'; } $parts = explode(':',$restStr); $parts[0]=$extPrfx.$parts[0]; if (!isset($this->LL_files_cache[$parts[0]])) { // Getting data if not cached $this->LL_files_cache[$parts[0]] = $this->readLLfile($parts[0]); // If the current language is found in another file, load that as well: $lFileRef = $this->localizedFileRef($parts[0]); if ($lFileRef && is_string($this->LL_files_cache[$parts[0]][$this->lang]) && $this->LL_files_cache[$parts[0]][$this->lang]=='EXT') { $tempLL = $this->readLLfile($lFileRef); $this->LL_files_cache[$parts[0]][$this->lang] = $tempLL[$this->lang]; } // Overriding file? if (isset($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$parts[0]])) { $ORarray = $this->readLLfile($GLOBALS['TYPO3_CONF_VARS']['BE']['XLLfile'][$parts[0]]); $this->LL_files_cache[$parts[0]] = t3lib_div::array_merge_recursive_overrule($this->LL_files_cache[$parts[0]],$ORarray); } } $this->LL_labels_cache[$this->lang][$input] = $this->getLLL($parts[1],$this->LL_files_cache[$parts[0]]); } return $hsc ? t3lib_div::deHSCentities(htmlspecialchars($this->LL_labels_cache[$this->lang][$input])) : $this->LL_labels_cache[$this->lang][$input]; // For the cached output charset conversion has already happend! So perform HSC right here. } }

---

Member Data Documentation

language::$charSet = 'iso-8859-1'

Definition at line 85 of file lang.php.

language::$charSetArray = array()

Definition at line 88 of file lang.php.

language::$csConvObj

Definition at line 107 of file lang.php.

language::$lang = 'default'

Definition at line 81 of file lang.php.

language::$langSplit = 'default'

Definition at line 82 of file lang.php.

language::$langSplitIndex = 0

Definition at line 101 of file lang.php.

language::$LL_files_cache = array()

Definition at line 102 of file lang.php.

language::$LL_labels_cache = array()

Definition at line 103 of file lang.php.

language::$moduleLabels = Array()

Definition at line 98 of file lang.php.

language::$origCharSet = ''

Definition at line 106 of file lang.php.

language::$typo3_help_url

Initial value: 'http: var $helpUrlArray = array( 'dk' => 'http://www.typo3.com/man_dk/', ) Definition at line 91 of file lang.php.

---

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

• typo3/sysext/lang/lang.php

---