LanguageHelper
in package
Language Helper for Development Tools Controller
Tags
Table of Contents
- $configuredLanguages : array<string|int, string>
- Configured languages (code => description)
- $loader : ExtendedIni
- Language loader
- __construct() : mixed
- Constructor
- compareLanguages() : array<string|int, mixed>
- Compare two languages and return an array of details about how they differ.
- getAllDetails() : array<string|int, mixed>
- Return language comparison information, using $mainLanguage as the baseline.
- getLangName() : string
- Get English name of language
- findDuplicatedValues() : array<string|int, mixed>
- Find duplicated values within the language.
- findMissingLanguageStrings() : array<string|int, mixed>
- Find strings that are absent from a language file.
- getAllLanguageDetails() : array<string|int, mixed>
- Return details on how all languages differ from $main.
- getHelpFiles() : array<string|int, mixed>
- Get a list of help files in the specified language.
- getLanguageDetails() : array<string|int, mixed>
- Return details on how $langCode differs from $main.
- getLanguages() : array<string|int, mixed>
- Get a list of languages supported by VuFind:
- getTextDomains() : array<string|int, mixed>
- Get text domains for a language.
- loadLanguage() : array<string|int, mixed>
- Load a language, including text domains.
- summarizeData() : array<string|int, mixed>
- Create summary data for use in the tabular display.
Properties
$configuredLanguages
Configured languages (code => description)
protected
array<string|int, string>
$configuredLanguages
$loader
Language loader
protected
ExtendedIni
$loader
Methods
__construct()
Constructor
public
__construct(ExtendedIni $loader[, array<string|int, mixed> $langs = [] ]) : mixed
Parameters
- $loader : ExtendedIni
-
Language loader
- $langs : array<string|int, mixed> = []
-
Configured languages (code => description)
Return values
mixed —compareLanguages()
Compare two languages and return an array of details about how they differ.
public
compareLanguages(TextDomain $lang1, TextDomain $lang2, TextDomain $lang1NoAliases, TextDomain $lang2NoAliases) : array<string|int, mixed>
Parameters
- $lang1 : TextDomain
-
Left side of comparison
- $lang2 : TextDomain
-
Right side of comparison
- $lang1NoAliases : TextDomain
-
Left side of comparison (with aliases disabled)
- $lang2NoAliases : TextDomain
-
Right side of comparison (with aliases disabled)
Return values
array<string|int, mixed> —getAllDetails()
Return language comparison information, using $mainLanguage as the baseline.
public
getAllDetails(string $mainLanguage[, bool $includeOptional = true ]) : array<string|int, mixed>
Parameters
- $mainLanguage : string
-
Language code
- $includeOptional : bool = true
-
Include optional translations (e.g. DDC23)
Return values
array<string|int, mixed> —getLangName()
Get English name of language
public
getLangName(string $lang) : string
Parameters
- $lang : string
-
Language code
Return values
string —findDuplicatedValues()
Find duplicated values within the language.
protected
findDuplicatedValues(TextDomain $lang) : array<string|int, mixed>
Parameters
- $lang : TextDomain
-
Language to analyze.
Return values
array<string|int, mixed> —findMissingLanguageStrings()
Find strings that are absent from a language file.
protected
findMissingLanguageStrings(TextDomain $lang1, TextDomain $lang2) : array<string|int, mixed>
Parameters
- $lang1 : TextDomain
-
Left side of comparison
- $lang2 : TextDomain
-
Right side of comparison
Return values
array<string|int, mixed> —getAllLanguageDetails()
Return details on how all languages differ from $main.
protected
getAllLanguageDetails(TextDomain $main, TextDomain $mainNoAliases, bool $includeOptional) : array<string|int, mixed>
Parameters
- $main : TextDomain
-
The main language (full details)
- $mainNoAliases : TextDomain
-
The main language (with aliases disabled)
- $includeOptional : bool
-
Include optional translations (e.g. DDC23)
Return values
array<string|int, mixed> —getHelpFiles()
Get a list of help files in the specified language.
protected
getHelpFiles(string $language) : array<string|int, mixed>
Parameters
- $language : string
-
Language to check.
Return values
array<string|int, mixed> —getLanguageDetails()
Return details on how $langCode differs from $main.
protected
getLanguageDetails(TextDomain $main, TextDomain $mainNoAliases, string $langCode, bool $includeOptional) : array<string|int, mixed>
Parameters
- $main : TextDomain
-
The main language (full details)
- $mainNoAliases : TextDomain
-
The main language (with aliases disabled)
- $langCode : string
-
The code of a language to compare against $main
- $includeOptional : bool
-
Include optional translations (e.g. DDC23)
Return values
array<string|int, mixed> —getLanguages()
Get a list of languages supported by VuFind:
protected
getLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTextDomains()
Get text domains for a language.
protected
getTextDomains(bool $includeOptional) : array<string|int, mixed>
Parameters
- $includeOptional : bool
-
Include optional translations (e.g. DDC23)
Return values
array<string|int, mixed> —loadLanguage()
Load a language, including text domains.
protected
loadLanguage(string $lang, bool $includeOptional[, bool $includeAliases = true ]) : array<string|int, mixed>
Parameters
- $lang : string
-
Language to load
- $includeOptional : bool
-
Include optional translations (e.g. DDC23)
- $includeAliases : bool = true
-
Include alias details
Return values
array<string|int, mixed> —summarizeData()
Create summary data for use in the tabular display.
protected
summarizeData(array<string|int, mixed> $details) : array<string|int, mixed>
Parameters
- $details : array<string|int, mixed>
-
Full details from getAllLanguageDetails()