API Language - evansims/openfga-php GitHub Wiki

Supported languages for OpenFGA SDK internationalization. This enum represents all available languages for SDK messages and error translations, providing type-safe language selection with rich metadata about each supported locale including native names, ISO codes, and text directionality.

OpenFGA

View source code

• UnitEnum
• BackedEnum

public function apply(): void

Apply this language as the active translation locale. Sets this language as the default locale for all subsequent translation operations until changed or reset.

View source

void

public function displayName(): string

Get the display name of the language in English. Returns the English name of the language for UI display and documentation purposes.

View source

string — The English name of the language

public function isActive(): bool

Check if this language is the currently active locale. Determines whether this language is currently set as the default locale for translation operations.

View source

bool — True if this is the active language

public function isRightToLeft(): bool

Check if this language uses right-to-left text direction. Useful for UI implementations that need to adjust layout direction based on the selected language.

View source

bool — True if the language is RTL

public function isoCode(): string

Get the ISO 639-1 two-letter language code. Returns the base language code without region specifier. For regional variants, this returns the primary language code.

View source

string — The ISO 639-1 language code

public function locale(): string

Get the locale code for this language. Returns the full locale identifier including any region specifier (e.g., "pt_BR" for Brazilian Portuguese).

View source

string — The locale code

public function nativeName(): string

Get the native name of the language. Returns the language name as written in that language, useful for language selection interfaces.

View source

string — The native language name

public function regionCode(): string|null

Get the region code if this is a regional language variant. Returns the ISO 3166-1 alpha-2 country code for regional language variants, or null for generic language codes.

View source

string | null — The region code or null

public function withLocale(callable $callback): T

Execute a callback with this language as the active locale. Temporarily sets this language as the active locale, executes the provided callback, then restores the previous locale. This ensures proper cleanup even if the callback throws.

View source

T — The result of the callback