Package DE_EPAGES::Installer::API::LanguagePack
This module provides language pack handling.
Example |
my $Installer = DE_EPAGES::Installer::API::LanguagePack->new( LanguageCode => 'es', ); $Installer->install; |
@EXPORT_OK |
Functions
- DictionaryXmlLocation
- DownloadLanguagePack
- GetLangPackURL
- GetLanguageVersionList
- GetLanguagesByVersion
- GetUsedLanguages
- LanguagePackLocation
- UntarLanguagePack
- deleteCtmplFiles
- deleteGlobalFiles
- dialectCode
- install
- installStoreType
- languageCode
- new
- storeName
- storeType
- storeTypeDir
- storeTypeVersion
- uninstall
DictionaryXmlLocation
Returns path to Dictionary.$Lang.xml in $hFlags->{Dir} (default: $ENV{EPAGES_CARTRIDGES}).
Syntax |
$Path = DictionaryXmlLocation($Lang, $hFlags); |
Example |
DictionaryXmlLocation('es', { Dir => $ENV{EPAGES_CARTRIDGES} }); DictionaryXmlLocation('es'); |
Input |
|
Return |
|
DownloadLanguagePack
Downloads language pack from http://www.epages.com/LanguagePacks/$Major/$Lang/$LangDir.tar.gz and copies it to $UnpackDir (default: $ENV{EPAGES_PATCHES}/LanguagePacks)
Syntax |
$LP = DownloadLanguagePack($Lang, $Version, $UnpackDir) |
Example |
$LP = DownloadLanguagePack('es', '6.12.0', "$ENV{EPAGES_PATCHES}/LanguagePacks"); $LP = DownloadLanguagePack('es', '6.12.0'); |
Input |
|
Return |
|
GetLangPackURL
Returns the URL for a language pack specified by $Lang and $Version in 3 parts: dirname, basename and suffix. The complete URL format of a langpack is http://www.epages.com/LanguagePacks/[major]/[lang]/langpack-[lang]-epagesMSpL.tar.gz where [major] is e.g. 6.12; M - main version (e.g. 6); S - sub version (e.g. 12); L - patch level, e.g. 0 (for 6.12.0)
Syntax |
($URLPrefix, $BaseName, $Ext) = GetLangPackURL($Lang, $Version); |
Input |
|
Return |
|
GetLanguageVersionList
Returns list of available language versions for all versions in space- separated string $GetVersion retrieved from http://www.epages.de/LanguagePacks/$Version/versions.txt
Syntax |
$VersionList = GetLanguageVersionList($GetVersion) |
Example |
$VersionList = GetLanguageVersionList('6.14 6.13.1') |
Input |
|
Return |
|
GetLanguagesByVersion
If $LanguageString is defined and does not contain 'any', simply splits it. Otherwise returns a list of available languages for specific epages version, retrieved from http://www.epages.de/LanguagePacks/$Version/index.txt
Syntax |
$aLanguages = GetLanguagesByVersion($Version, $LanguageString); |
Example |
@Languages = @{GetLanguagesByVersion('6.12.0', 'es it')}; @Languages = @{GetLanguagesByVersion('6.12.0', 'es any it')}; @Languages = @{GetLanguagesByVersion('6.12.0')}; @Languages = @{GetLanguagesByVersion('6.12', 'any')}; |
Input |
|
Return |
|
GetUsedLanguages
Returns the hashes $hStoreTypeLanguages (all languages per storetype) and $hStoreLanguages (all stores per language) for all stores in $aStoreNames.
Syntax |
my ($hStoreTypeLanguages, $hStoreLanguages) = GetUsedLanguages($aStoreNames, $hFlags) |
Example |
my ($StoreTypeLang, $StoreLang) = GetUsedLanguages(['Store'], {Ignore => [qw(de en)]}); |
Input |
|
Return |
|
LanguagePackLocation
Finds the first occurence of language pack with $Lang and $Version as .tar.gz file in any of $hFlags->{Dir} (default: $ENV{EPAGES_PATCHES}/LanguagePacks). If not found, return $DirList->[0]/$LangPack (unless $hFlags->{IfExists}).
Syntax |
$LP = LanguagePackLocation($Lang, $Version, $hFlags) |
Example |
LanguagePackLocation('es', '6.12.0', {Dir => ["$ENV{EPAGES_PATCHES}/LanguagePacks"]}); LanguagePackLocation('es', '6.12.0'); |
Input |
|
Return |
|
UntarLanguagePack
Unpacks language pack .tar.gz file into $UnpackDir (default: $ENV{EPAGES_PATCHES}/LanguagePacks). .tar.gz file must exist in $UnpackDir.
Syntax |
UntarLanguagePack($Lang, $Version, $UnpackDir, $hFlags) |
Example |
UntarLanguagePack('es', '6.12.0', "$ENV{EPAGES_PATCHES}/LanguagePacks"); UntarLanguagePack('es', '6.12.0', undef, {Print => 1} ); |
Input |
|
Return |
|
deleteCtmplFiles
Deletes .ctmpl files of a language from EPAGES_STATIC.
Syntax |
$Installer->deleteCtmplFiles; |
deleteGlobalFiles
Deletes language files from the directories EPAGES_CARTRIDGES and EPAGES_WEBROOT/Doc.
Syntax |
$Installer->deleteGlobalFiles; |
dialectCode
Returns the dialect code of a language of the language pack.
Syntax |
$DialectCode = $Installer->dialectCode; |
Return |
|
install
Installs language pack database strings and files.
Syntax |
$Installer->install; |
installStoreType
Installs language pack files for /Data/Public and /Data/javascript.
Syntax |
$Installer->installStoreType; |
languageCode
Returns the language code of the language pack.
Syntax |
$LanguageCode = $Installer->languageCode; |
Return |
|
new
Creates a new language pack installer.
Syntax |
$Installer = DE_EPAGES::Installer::API::LanguagePack->new(%options); |
Input |
|
Return |
|
storeName
Returns the logical name of the current database. Throws an error if there is no database connection.
Syntax |
$StoreName = $Installer->storeName; |
Return |
|
storeType
Returns the type of the current database. Throws an error if there is no database connection.
Syntax |
$StoreType = $Installer->storeType; |
Return |
|
storeTypeDir
The cartridge will be installed into this store type directory.
Syntax |
$StoreTypeDir = $Installer->storeTypeDir; |
Return |
|
storeTypeVersion
The cartridge will be installed for this store type version.
Syntax |
$StoreTypeVersion = $Installer->storeTypeVersion; |
Return |
|
uninstall
Deletes language pack database strings and files.
Syntax |
$Installer->uninstall; |