class LanguagePack implements ExtenderInterface, LifecycleInterface

Declaring a language pack's code, title and direction in composer.json as "extra.flarum-locale" is deprecated since 2.1 and will be removed in 3.0: use code(), title() and direction() instead.

Constants

CORE_LOCALE_FILES

Methods

__construct(string $path = '/locale')

LanguagePack constructor.

code(string $code)

The locale code, such as "en" or "pt-BR".

title(string $title)

The language's name, written in that language.

direction(string $direction)

The direction the language is written in.

void
extend( Container $container, Extension|null $extension = null)

No description

void
onEnable( Container $container, Extension $extension)

No description

void
onDisable( Container $container, Extension $extension)

No description

Details

__construct(string $path = '/locale')

LanguagePack constructor.

Parameters

string $path : Path to yaml language files.

LanguagePack code(string $code)

The locale code, such as "en" or "pt-BR".

Parameters

string $code

Return Value

LanguagePack

LanguagePack title(string $title)

The language's name, written in that language.

Parameters

string $title

Return Value

LanguagePack

LanguagePack direction(string $direction)

The direction the language is written in.

Parameters

string $direction : "ltr" or "rtl". Defaults to "ltr" when not set.

Return Value

LanguagePack

void extend( Container $container, Extension|null $extension = null)

Parameters

Container $container
Extension|null $extension

Return Value

void

void onEnable( Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void

void onDisable( Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void