Interface: ILanguageManager

Interface for localization support.

Extends

\SmartFactory\Interfaces\IInitable

Known implementations

\SmartFactory\LanguageManager

Authors

Oleg Schildt

Package

System

Source code

SmartFactory/Interfaces/ILanguageManager.php

Methods
addLocalizationFile() public	Adds additional localization files to the dictionary.
detectLanguage() public	This function should detect the current language based on cookies, browser languages etc.
extendDictionary() public	Adds additional translations to the dictionary.
getContext() public	Returns the current context.
getCountryCode() public	Tries to find the country code by the given name.
getCountryList() public	Provides the list of countries for the given language in the form "code" => "translation".
getCountryName() public	Provides the text translation for the country name by the code for the given language.
getCurrentLanguage() public	Returns the current language.
getFallbackLanguage() public	Returns the fallback language. If set and a translation is missing on a language, the translation on this language will be used.
getLanguageCode() public	Tries to find the language code by the given name.
getLanguageList() public	Provides the list of languages for the given language in the form "code" => "translation".
getLanguageName() public	Provides the text translation for the language name by the code for the given language.
getSupportedLanguages() public	Returns the list of supported languages.
hasTranslation() public	Checks whether the text translation for the text ID for the given language exists.
init() public	Initializes the language manager with parameters.
loadDictionary() public	This is function for loading the translations from the source JSON file.
setContext() public	Sets the current context.
setCurrentLanguage() public	Sets the current language.
text() public	Provides the text translation for the text ID for the given language.
try_text() public	Provides the text translation for the text ID for the given language if the translation exists.
validateCountryCode() public	Checks whether the country code is valid (has translation).
validateLanguageCode() public	Checks whether the language code is valid (has translation).

Method: ILanguageManager::addLocalizationFile()

public function addLocalizationFile(string $localization_file): void;

Adds additional localization files to the dictionary.

Parameters

Name	Pass type	Value type	Default value	Description
$localization_file	by value	string		The path of the additional localization file.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::detectLanguage()

public function detectLanguage(): void;

This function should detect the current language based on cookies, browser languages etc.

Details

Some applications may consist of two parts - administration console and public site. A usual example is a CMS system.

For example, you are using administration console in English and editing the public site for German and French. When you open the public site for preview in German or French, you want it to be open in the corresponding language, but the administration console should remain in English.

With the help of $context, you are able to maintain different languages for different parts of your application. If you do not need the $context, just do not specify it.

Returns

void

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::extendDictionary()

public function extendDictionary(array $dictionary): void;

Adds additional translations to the dictionary.

Parameters

Name	Pass type	Value type	Default value	Description
$dictionary	by value	array		The array with additional translations.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getContext()

public function getContext(): string;

Returns the current context.

Details

Some applications may consist of two parts - administration console and public site. A usual example is a CMS system.

With the help of $context, you are able to maintain different languages for different parts of your application. If you do not need the $context, just do not specify it.

Returns

string

Returns the current context.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getCountryCode()

public function getCountryCode(string $country_name): string;

Tries to find the country code by the given name.

Parameters

Name	Pass type	Value type	Default value	Description
$country_name	by value	string		The name of the country in any supported language.

Returns

string

Returns the country code if it could be found, otherwise an empty string.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getCountryList()

public function getCountryList(array &$country_list, string $lng = "", array $display_first = []): bool;

Provides the list of countries for the given language in the form "code" => "translation".

Parameters

Name	Pass type	Value type	Default value	Description
$country_list	by reference	array		Target array where the country list should be loaded.
$lng	by value	string	""	The language. If it is not specified, the default language is used.
$display_first	by value	array	[]	List of the country codes to be displayed first in the order, they appear in the list.

Returns

bool

Returns true if the country list is successfully retrieved, otherwise false.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getCountryName()

public function getCountryName(string $code, string $lng = ""): string;

Provides the text translation for the country name by the code for the given language.

Parameters

Name	Pass type	Value type	Default value	Description
$code	by value	string		Country ISO code (uppercase, e.g. US, DE, FR).
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

string

Returns the translation text for the country name or the $code if no translation is found.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getCurrentLanguage()

public function getCurrentLanguage(): string;

Returns the current language.

Returns

string

Returns the current language ISO code.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getFallbackLanguage()

public function getFallbackLanguage(): string;

Returns the fallback language. If set and a translation is missing on a language, the translation on this language will be used.

Returns

string

Returns the fallback language.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getLanguageCode()

public function getLanguageCode(string $lang_name): string;

Tries to find the language code by the given name.

Parameters

Name	Pass type	Value type	Default value	Description
$lang_name	by value	string		The name of the language in any supported language.

Returns

string

Returns the language code if it could be found, otherwise an empty string.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getLanguageList()

public function getLanguageList(array &$language_list, string $lng = "", array $display_first = []): bool;

Provides the list of languages for the given language in the form "code" => "translation".

Parameters

Name	Pass type	Value type	Default value	Description
$language_list	by reference	array		Target array where the language list should be loaded.
$lng	by value	string	""	The language. If it is not specified, the default language is used.
$display_first	by value	array	[]	List of the language codes to be displayed first in the order, they appear in the list.

Returns

bool

Returns true if the language list is successfully retrieved, otherwise false.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getLanguageName()

public function getLanguageName(string $code, string $lng = ""): string;

Provides the text translation for the language name by the code for the given language.

Parameters

Name	Pass type	Value type	Default value	Description
$code	by value	string		Language ISO code (lowercase, e.g. en, de, fr).
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

string

Returns the translation text for the language name or the $code if no translation is found.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::getSupportedLanguages()

public function getSupportedLanguages(): array;

Returns the list of supported languages.

Returns

array

Returns the list of supported languages.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::hasTranslation()

public function hasTranslation(string $text_id, string $lng = ""): bool;

Checks whether the text translation for the text ID for the given language exists.

Parameters

Name	Pass type	Value type	Default value	Description
$text_id	by value	string		Text ID
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

bool

Returns true if the translation exists, otherwise false.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::init()

public function init(array $parameters): void;

Initializes the language manager with parameters.

Parameters

Name	Pass type	Value type	Default value	Description
$parameters	by value	array		The parameters may vary for each language manager.

Returns

void

Throws

\Exception

It might throw an exception in the case of any system errors.

Overrides

\SmartFactory\Interfaces\IInitable::init()

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::loadDictionary()

public function loadDictionary(): void;

This is function for loading the translations from the source JSON file.

Returns

void

Throws

\Exception

It might throw the following exceptions in the case of any errors:

if the translation file is invalid.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::setContext()

public function setContext(string $context): void;

Sets the current context.

Details

Some applications may consist of two parts - administration console and public site. A usual example is a CMS system.

With the help of $context, you are able to maintain different languages for different parts of your application. If you do not need the $context, just do not specify it.

Parameters

Name	Pass type	Value type	Default value	Description
$context	by value	string		The name of the context.

Returns

void

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::setCurrentLanguage()

public function setCurrentLanguage(string $language): void;

Sets the current language.

Parameters

Name	Pass type	Value type	Default value	Description
$language	by value	string		The language ISO code to be set.

Returns

void

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::text()

public function text(string $text_id, string $lng = "", string $default_text = ""): string;

Provides the text translation for the text ID for the given language.

Parameters

Name	Pass type	Value type	Default value	Description
$text_id	by value	string		Text ID
$lng	by value	string	""	The language. If it is not specified, the default language is used.
$default_text	by value	string	""	The default text to be used if there is no translation.

Returns

string

Returns the translation text or the $default_text/$text_id if no translation is found.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::try_text()

public function try_text(string $text_id, string $lng = ""): string;

Provides the text translation for the text ID for the given language if the translation exists.

Details

Otherwise, it returns the text ID and emits no warning.

Parameters

Name	Pass type	Value type	Default value	Description
$text_id	by value	string		Text ID
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

string

Returns the translation text or the $default_text/$text_id if no translation is found.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::validateCountryCode()

public function validateCountryCode(string $code, string $lng = ""): bool;

Checks whether the country code is valid (has translation).

Parameters

Name	Pass type	Value type	Default value	Description
$code	by value	string		Country ISO code (uppercase, e.g. US, DE, FR).
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

bool

Returns true if the country code is valid (has translation), otherwise false.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Method: ILanguageManager::validateLanguageCode()

public function validateLanguageCode(string $code, string $lng = ""): bool;

Checks whether the language code is valid (has translation).

Parameters

Name	Pass type	Value type	Default value	Description
$code	by value	string		Language ISO code (lowercase, e.g. en, de, fr).
$lng	by value	string	""	The language. If it is not specified, the default language is used.

Returns

bool

Returns true if the language code is valid (has translation), otherwise false.

Authors

Oleg Schildt

Source code

SmartFactory/Interfaces/ILanguageManager.php

Interface: ILanguageManager

Extends

Known implementations

Authors

Package

Source code

Method: ILanguageManager::addLocalizationFile()

Parameters

Returns

Throws

Authors

Source code

Method: ILanguageManager::detectLanguage()

Details

Returns

Authors

Source code

Method: ILanguageManager::extendDictionary()

Parameters

Returns

Throws

Authors

Source code

Method: ILanguageManager::getContext()

Details

Returns

Authors

Source code

Method: ILanguageManager::getCountryCode()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getCountryList()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getCountryName()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getCurrentLanguage()

Returns

Authors

Source code

See also

Method: ILanguageManager::getFallbackLanguage()

Returns

Authors

Source code

Method: ILanguageManager::getLanguageCode()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getLanguageList()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getLanguageName()

Parameters

Returns

Authors

Source code

See also

Method: ILanguageManager::getSupportedLanguages()

Returns

Authors

Source code

Method: ILanguageManager::hasTranslation()

Parameters

Returns