1. class
  2. Alxarafe
  3. \
  4. Core
  5. \
  6. Providers
  7. \
  8. Translator

Translator

class Translator

Class Lang, give support to internationalization.

Traits

Singleton
Trait Singleton, This class ensures that all class that use this have only one instance of itself if called as: Class::getInstance()

Constants

FALLBACK_LANG

Default language to use if language file not exists.
LANG_FOLDER

Base folder where languages files are stored.
LANG

Default language to use.
EXT

Extension of language file.
FORMAT

Format of language file.

Properties

static protected bool $singletonArray Set to true if you want use more that one singleton using and index param in getInstance from Singleton
static protected string $basePath The base path where config files are placed. from Singleton
static private string $className Name of the class from Singleton
static private array $instances Hold the classes on instance. from Singleton
protected bool $separateConfigFile Set to true if you want to save configuration in a separate file from Singleton
static private Translator $translator The Symfony translator.
static private array $usedStrings List of used strings.
static private array $missingStrings List of strings without translation.
static private string $languageFolder Main language folder.
static private array $languageFolders Array of all language folders.

Methods

static Translator
getInstance()

Return this instance.

static string
getClassName()

Returns the class name.

from Singleton
bool
setConfig(array $params, bool $merge = true, string $index = 'main')

Save config to file.

from Singleton
array
getYamlContent()

Returns the content of the Yaml file.

from Singleton
string
getFilePath()

Return the full file config path.

from Singleton
string
getFileName()

Return the file name.

from Singleton
static string
yamlName()

Return the classname for yaml file.

from Singleton
bool
fileExists(string $filename)

Returns if file exists.

from Singleton
array
getConfig(string $index = 'main')

Returns the yaml config params.

from Singleton
static array
getDefaultValues()

Return default values

string
getBasePath()

Return the base path.

from Singleton
initSingleton()

Initialization, equivalent to __construct and must be called from main class.

from Singleton
__construct()

Lang constructor.

void
loadLangFiles()

Load the translation files following the priorities.

array
getLangFolders()

Return the lang folders.

string
getBaseLangFolder()

Returns the base lang folder.

addDirs(array $folders = [])

Add additional language folders.

void
setlocale(string $lang)

Sets the language code in use.

array
getAvailableLanguages()

Returns an array with the languages with available translations.

string
trans(null|string $txt, array $parameters = [], $domain = null, $locale = null)

Translate the text into the default language.

verifyMissing(string $translated, null|string $txt, null|string $domain = null)

Stores if translation is used and if is missing.

string
getLocale()

Returns the language code in use.

array
getMissingStrings()

Returns the missing strings.

array
getUsedStrings()

Returns the strings used.

Translator
getTranslator()

Returns the original translator.

Details

at line 159
static Translator getInstance()

Return this instance.

Return Value

Translator

in Singleton at line 88
static private string getClassName()

Returns the class name.

Return Value

string

in Singleton at line 103
bool setConfig(array $params, bool $merge = true, string $index = 'main')

Save config to file.

Parameters

array $params
bool $merge
string $index

Return Value

bool

in Singleton at line 130
private array getYamlContent()

Returns the content of the Yaml file.

Return Value

array

in Singleton at line 152
string getFilePath()

Return the full file config path.

Return Value

string

in Singleton at line 162
string getFileName()

Return the file name.

Return Value

string

in Singleton at line 172
static string yamlName()

Return the classname for yaml file.

Return Value

string

in Singleton at line 184
protected bool fileExists(string $filename)

Returns if file exists.

Parameters

string $filename

Return Value

bool

in Singleton at line 196
array getConfig(string $index = 'main')

Returns the yaml config params.

Parameters

string $index

Return Value

array

at line 169
static array getDefaultValues()

Return default values

Return Value

array

in Singleton at line 215
string getBasePath()

Return the base path.

Return Value

string

in Singleton at line 223
protected initSingleton()

Initialization, equivalent to __construct and must be called from main class.

at line 90
__construct()

Lang constructor.

at line 112
void loadLangFiles()

Load the translation files following the priorities.

In this case, the translator must be provided with the routes in reverse order.

Return Value

void

at line 136
array getLangFolders()

Return the lang folders.

Return Value

array

at line 149
string getBaseLangFolder()

Returns the base lang folder.

Return Value

string

at line 179
addDirs(array $folders = [])

Add additional language folders.

Parameters

array $folders

at line 197
void setlocale(string $lang)

Sets the language code in use.

Parameters

string $lang

Return Value

void

at line 207
array getAvailableLanguages()

Returns an array with the languages with available translations.

Return Value

array

at line 235
string trans(null|string $txt, array $parameters = [], $domain = null, $locale = null)

Translate the text into the default language.

Parameters

null|string $txt
array $parameters
$domain
$locale

Return Value

string

at line 249
private verifyMissing(string $translated, null|string $txt, null|string $domain = null)

Stores if translation is used and if is missing.

Parameters

string $translated
null|string $txt
null|string $domain

at line 277
string getLocale()

Returns the language code in use.

Return Value

string

at line 287
array getMissingStrings()

Returns the missing strings.

Return Value

array

at line 297
array getUsedStrings()

Returns the strings used.

Return Value

array

at line 307
Translator getTranslator()

Returns the original translator.

Return Value

Translator