Locale.php
Table of Contents
Functions
- bb_get_locales() : null|array<string|int, mixed>
- Gets all installed BB4 Locales
- bb_get_installed_locales() : null|array<string|int, mixed>
- Gets all installed BB4 Locales
- locale_get_info() : array<string|int, null|string>
- Gets all essential informations about a bb4 locale
- bb_load_locale() : null|I18nLanguage
- Loads a locale by its fqn or null if nothing similiar can be found
- bb_this_locale() : null|I18nLanguage
- Gets the current active Locale or null if the initialization isn't executed successfully
- bb_set_this_locale() : void
- Sets the current active Locale
- bb_get_localedir() : string
- Gets the directory for the Locale Files
- bb_get_string() : null|string
- Gets the Localized String by its Path
- __() : null|string
- Alias for "bb_get_string"
- ___() : null|string
- Gets the String using a Context instead of a Path
- bb_format_i18n_data() : null|array<string|int, mixed>
- Formats all I18n Data Strings with the given vars
Functions
bb_get_locales()
Gets all installed BB4 Locales
bb_get_locales() : null|array<string|int, mixed>
Return values
null|array<string|int, mixed>bb_get_installed_locales()
Gets all installed BB4 Locales
bb_get_installed_locales() : null|array<string|int, mixed>
Return values
null|array<string|int, mixed>locale_get_info()
Gets all essential informations about a bb4 locale
locale_get_info(I18nLanguage $locale) : array<string|int, null|string>
Parameters
- $locale : I18nLanguage
Return values
array<string|int, null|string>bb_load_locale()
Loads a locale by its fqn or null if nothing similiar can be found
bb_load_locale(mixed $fqn) : null|I18nLanguage
Parameters
- $fqn : mixed
-
Full Qualified Name of the Language
Return values
null|I18nLanguagebb_this_locale()
Gets the current active Locale or null if the initialization isn't executed successfully
bb_this_locale() : null|I18nLanguage
Return values
null|I18nLanguagebb_set_this_locale()
Sets the current active Locale
bb_set_this_locale(I18nLanguage $locale) : void
Parameters
- $locale : I18nLanguage
-
Locale Instance
bb_get_localedir()
Gets the directory for the Locale Files
bb_get_localedir() : string
Return values
stringbb_get_string()
Gets the Localized String by its Path
bb_get_string(mixed $path[, string|int|float $values = null ]) : null|string
Parameters
- $path : mixed
-
StringPath
- $values : string|int|float = null
-
Values
Return values
null|string__()
Alias for "bb_get_string"
__(mixed $path[, string|int|float $values = null ]) : null|string
Parameters
- $path : mixed
-
StringPath
- $values : string|int|float = null
-
Values
Return values
null|string___()
Gets the String using a Context instead of a Path
___(mixed $string[, mixed $values = null ][, mixed $context = null ]) : null|string
Parameters
- $string : mixed
-
The Strings Name
- $values : mixed = null
-
Values to insert
- $context : mixed = null
-
Context or null for current context
Return values
null|stringbb_format_i18n_data()
Formats all I18n Data Strings with the given vars
bb_format_i18n_data(mixed $localeData, mixed $subVars) : null|array<string|int, mixed>
Parameters
- $localeData : mixed
- $subVars : mixed