Class cModuleFileTranslation

This class save the translations from a modul in a file and get it from file.

cModuleFileTranslation

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Rusmir Jusufovic
Located at classes/module/class.module.filetranslation.php

Methods summary
`public`	# `__construct( integer $idmodul = NULL, boolean $static = false, integer $overrideIdlang = NULL )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$idmodul` `integer` $idmodul [optional] `$static` `boolean` $static [optional] if true it will load once the translation from file `$overrideIdlang` `integer` $overrideIdlang [optional] use different language if not NULL Throws `cException` `cInvalidArgumentException` Overrides `cModuleHandler::__construct()`
`private string`	# `_getValueFromProperties( string $type, string $name )` Get the value of a item from properties db. Get the value of a item from properties db. Parameters `$type` `string` $type `$name` `string` $name Returns `string` value Throws `cDbException` `cException`
`public array`	# `getLangArray( )` Get the lang array. Get the lang array. Returns `array`
`public`	# `saveTranslations( )` Save the hole translations for a idmod and lang. For the upgrade/setup. Save the hole translations for a idmod and lang. For the upgrade/setup. Throws `cDbException` `cException`
`private string`	# `_serializeArray( array $wordListArray )` This method serialize an array. This method serialize an array. $key.[Divider].$value."\r\n" Parameters `$wordListArray` `array` $wordListArray Returns `string`
`private array`	# `_unserializeArray( string $string )` This method unserialize a string. The contents of file looks like <Original String><Divider><Translation String>. This method unserialize a string. The contents of file looks like <Original String><Divider><Translation String>. Example: If divider is "=" Hello World=Hallo Welt Parameters `$string` `string` $string the contents of the file Returns `array`
`public boolean`	# `saveTranslationArray( array $wordListArray )` Save the contents of the wordListArray in file. Save the contents of the wordListArray in file. Parameters `$wordListArray` `array` $wordListArray Returns `boolean` true on success or false on failure Throws `cInvalidArgumentException`
`public array`	# `getTranslationArray( )` Get the translations array. Get the translations array. Returns `array` Throws `cInvalidArgumentException`

Methods inherited from cModuleHandler
_initByModule(), _makeModuleDirectory(), _testCode(), _verifyCode(), changeModuleName(), createModule(), createModuleDirectory(), createModuleFile(), deleteFile(), eraseModule(), existFile(), getAllFilesFromDirectory(), getCleanName(), getCssFileName(), getCssPath(), getEncoding(), getFilesContent(), getJsFileName(), getJsPath(), getModuleName(), getModulePath(), getPhpPath(), getRandomCharacters(), getTemplatePath(), initWithDatabaseRow(), isWritable(), modulePathExists(), modulePathExistsInDirectory(), moduleWriteable(), readInput(), readOutput(), renameModul(), renameModuleFile(), saveContentToFile(), saveInfoXML(), saveInput(), saveOutput(), testInput(), testOutput()

Properties summary
`private string`	`$_modulePath`		# Path to the modul directory. Path to the modul directory.
`public static string`	`$fileName`	`''`	# Name of the translations file. Name of the translations file.
`public static array`	`$langArray`	`array()`	# Translation array. Translation array.
`public static integer`	`$savedIdMod`	`NULL`	# The id of the modul. The id of the modul.
`public static string`	`$originalTranslationDivider`	`'='`	#

Properties inherited from cModuleHandler
`$_cfg, $_cfgClient, $_client, $_description, $_directories, $_encoding, $_encodingStore, $_fileEncoding, $_idlang, $_idmod, $_input, $_moduleAlias, $_output, $_type`

Packages

Classes

Functions

Class cModuleFileTranslation

Parameters

Throws

Overrides

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws