Documentation TYPO3 par Ameos |
Public Member Functions | |
| init ($lang, $altPath='') | |
| addModuleLabels ($arr, $prefix) | |
| hscAndCharConv ($lStr, $hsc) | |
| makeEntities ($str) | |
| JScharCode ($str) | |
| getLL ($index, $hsc=0) | |
| getLLL ($index, $LOCAL_LANG, $hsc=0) | |
| sL ($input, $hsc=0) | |
| loadSingleTableDescription ($table) | |
| includeLLFile ($fileRef, $setGlobal=1, $mergeLocalOntoDefault=0) | |
| readLLfile ($fileRef) | |
| localizedFileRef ($fileRef) | |
Public Attributes | |
| $lang = 'default' | |
| $langSplit = 'default' | |
| $charSet = 'iso-8859-1' | |
| $charSetArray = array() | |
| $typo3_help_url = 'http://www.typo3.com/man_uk/' | |
| $helpUrlArray | |
| $debugKey = FALSE | |
| $moduleLabels = Array() | |
| $langSplitIndex = 0 | |
| $LL_files_cache = array() | |
| $LL_labels_cache = array() | |
| $origCharSet = '' | |
| $csConvObj | |
Definition at line 88 of file lang.php.
| 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']);
| string | The language key (two character string from backend users profile) | |
| string | IGNORE. Not used. |
Definition at line 138 of file lang.php.
References $lang, t3lib_div::makeInstance(), and t3lib_BEfunc::typo3PrintError().
| language::addModuleLabels | ( | $ | arr, | |
| $ | prefix | |||
| ) |
Adds labels and image references from the backend modules to the internal moduleLabels array
| array | Array with references to module labels, keys: ['labels']['tablabel'], ['labels']['tabdescr'], ['tabs']['tab'] | |
| string | Module name prefix |
| 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.
| string | The string to process | |
| boolean | If set, then the string is htmlspecialchars()'ed |
| 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
| string | Input string |
| 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.
| string | Input string, encoded with $this->charSet |
| 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.
| string | Label key | |
| boolean | If set, the return value is htmlspecialchar'ed |
Definition at line 260 of file lang.php.
References hscAndCharConv().
| 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.
| string | Label key | |
| array | $LOCAL_LANG array to get label key from | |
| boolean | If set, the return value is htmlspecialchar'ed |
Definition at line 278 of file lang.php.
References hscAndCharConv().
Referenced by sL().
| 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 deprecated to use 'language-splitted' label strings) Refer to 'Inside TYPO3' for more details
| string | Label key/reference | |
| boolean | If set, the return value is htmlspecialchar'ed |
Definition at line 299 of file lang.php.
References t3lib_div::array_merge_recursive_overrule(), t3lib_div::deHSCentities(), getLLL(), hscAndCharConv(), localizedFileRef(), and readLLfile().
| 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
| string | Table name found as key in global array $TCA_DESCR |
Definition at line 344 of file lang.php.
References includeLLFile().
| 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).
| 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. |
Definition at line 396 of file lang.php.
References t3lib_div::array_merge_recursive_overrule(), localizedFileRef(), and readLLfile().
Referenced by loadSingleTableDescription().
| language::readLLfile | ( | $ | fileRef | ) |
Includes a locallang file and returns the $LOCAL_LANG array found inside.
| 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. |
Definition at line 441 of file lang.php.
References t3lib_div::readLLfile().
Referenced by includeLLFile(), and sL().
| language::localizedFileRef | ( | $ | fileRef | ) |
Returns localized fileRef (.[langkey].php)
| string | Filename/path of a 'locallang.php' file |
Definition at line 451 of file lang.php.
Referenced by includeLLFile(), and sL().
| language::$helpUrlArray |
1.4.6