1. class
  2. Waterhole
  3. \
  4. Translation
  5. \
  6. FluentTranslator

FluentTranslator

final class FluentTranslator implements Translator (View source)

Translator decorator that adds support for Fluent translations.

This class is adapted from the laravel-fluent package. This version of the class adds support for:

  • Loading namespaced translations from .ftl files, and allowing them to be overridden by the consumer.
  • Adding functions to FluentBundle instances.
  • Accept an array of keys and use the first one that exists.
  • Cache parsed Fluent bundles.

Methods

__construct(Translator $baseTranslator, Filesystem $files, string $path, string $locale, string $fallback, array $bundleOptions, string|null $cachePath = null, array $functions = [])

No description

bool
hasForLocale(string $key, string|null $locale = null)

No description

bool
has(string $key, string|null $locale = null, bool $fallback = true)

No description

string|array
get(string|array $key, array $replace = [], ?string $locale = null, bool $fallback = true)

No description

FluentBundle|false
loadPath(string $path, string $locale, string $group)

No description

void
flush()

No description

FluentBundle|false
loadNamespaced(string $locale, string $group, string $namespace)

No description

FluentBundle
loadNamespaceOverrides(FluentBundle $bundle, $locale, $group, $namespace)

No description

choice($key, $number, array $replace = [], $locale = null)

No description

void
addLines(array $lines, string $locale, string $namespace = '*')

No description

void
load(string $namespace, string $group, string $locale)

No description

void
addNamespace(string $namespace, string $hint)

No description

void
addJsonPath(string $path)

No description

array
parseKey(string $key)

No description

MessageSelector
getSelector()

No description

void
setSelector(MessageSelector $selector)

No description

Loader
getLoader()

No description

string
locale()

No description

string
getLocale()

No description

void
setLocale(string $locale)

No description

string
getFallback()

No description

void
setFallback(string $locale)

No description

Details

at line 37
__construct(Translator $baseTranslator, Filesystem $files, string $path, string $locale, string $fallback, array $bundleOptions, string|null $cachePath = null, array $functions = [])

No description

Parameters

Translator $baseTranslator
Filesystem $files
string $path
string $locale
string $fallback
array $bundleOptions
string|null $cachePath
array $functions

at line 50
bool hasForLocale(string $key, string|null $locale = null)

No description

Parameters

string $key
string|null $locale

Return Value

bool

at line 55
bool has(string $key, string|null $locale = null, bool $fallback = true)

No description

Parameters

string $key
string|null $locale
bool $fallback

Return Value

bool

at line 66
string|array get(string|array $key, array $replace = [], ?string $locale = null, bool $fallback = true)

No description

Parameters

string|array $key
array $replace
?string $locale
bool $fallback

Return Value

string|array

at line 123
protected FluentBundle|false loadPath(string $path, string $locale, string $group)

No description

Parameters

string $path
string $locale
string $group

Return Value

FluentBundle|false

at line 162
void flush()

No description

Return Value

void

at line 171
protected FluentBundle|false loadNamespaced(string $locale, string $group, string $namespace)

No description

Parameters

string $locale
string $group
string $namespace

Return Value

FluentBundle|false

at line 195
protected FluentBundle loadNamespaceOverrides(FluentBundle $bundle, $locale, $group, $namespace)

No description

Parameters

FluentBundle $bundle
$locale
$group
$namespace

Return Value

FluentBundle

at line 217
choice($key, $number, array $replace = [], $locale = null)

No description

Parameters

$key
$number
array $replace
$locale

at line 225
void addLines(array $lines, string $locale, string $namespace = '*')

No description

Parameters

array $lines
string $locale
string $namespace

Return Value

void

at line 230
void load(string $namespace, string $group, string $locale)

No description

Parameters

string $namespace
string $group
string $locale

Return Value

void

at line 235
void addNamespace(string $namespace, string $hint)

No description

Parameters

string $namespace
string $hint

Return Value

void

at line 240
void addJsonPath(string $path)

No description

Parameters

string $path

Return Value

void

at line 248
array parseKey(string $key)

No description

Parameters

string $key

Return Value

array

at line 253
MessageSelector getSelector()

No description

Return Value

MessageSelector

at line 258
void setSelector(MessageSelector $selector)

No description

Parameters

MessageSelector $selector

Return Value

void

at line 263
Loader getLoader()

No description

Return Value

Loader

at line 268
string locale()

No description

Return Value

string

at line 273
string getLocale()

No description

Return Value

string

at line 281
void setLocale(string $locale)

No description

Parameters

string $locale

Return Value

void

at line 287
string getFallback()

No description

Return Value

string

at line 292
void setFallback(string $locale)

No description

Parameters

string $locale

Return Value

void