Locale

Allow to manage and lookup the locale for the localisation

• Full name: \Zemit\Locale
• Parent class: \Zemit\Di\Injectable
• This class implements: \Zemit\Support\Options\OptionsInterface

Constants

Properties

mode

Locale mode Locale::MODE_DEFAULT 'default' (Router -> http) Locale::MODE_SESSION 'session' (Router -> session -> http)

public string $mode

locale

The actual locale that was picked

public string|null $locale

sessionKey

Session key for storing the locale

public string $sessionKey

default

Default locale

public string $default

This variable holds the default locale value for the application. If no locale is explicitly specified, this value will be used.

allowed

Array of allowed languages.

public array $allowed

Methods

initialize

Initializes the object by setting its properties based on the provided options.

public initialize(): void

This method retrieves the values of the sessionKey, allowed, default, and mode options using the getOption() method. If these options are not provided, the default values specified in the class properties are used instead.

It then sets the obtained values to the corresponding class properties using the appropriate setter methods, namely setAllowed(), setDefault(), and setMode(). Additionally, it assigns the obtained sessionKey value directly to the sessionKey property.

Finally, the initialize() method prepares the default value by calling the prepare() method with the getDefault() method as its parameter.

get

Alias of the getLocale() method

public get(): ?string

getLocale

Retrieves the locale value of the object.

public getLocale(): string|null

This method returns the value of the locale property, which represents the current locale of the object. The locale property is set using the setLocale() method or may be null if no locale is set.

Return Value:

The locale value of the object, or null if no locale is set.

setLocale

Set the current locale value

public setLocale(?string $locale = null): void

Parameters:

getDefault

Get the default locale

public getDefault(): string

setDefault

Set the default locale value

public setDefault(string $locale): void

Parameters:

getAllowed

Get the list of possible locale

public getAllowed(): array

setAllowed

Set the allowed locale

public setAllowed(array $allowed): void

Parameters:

getMode

Get the defined mode

public getMode(): string

setMode

Set the mode

public setMode(string $mode): void

Parameters:

prepare

Prepare and set and return the locale based on the defined mode

public prepare(?string $default = null): ?string

Parameters:

getFromRoute

Retrieves the locale from the route

public getFromRoute(?string $default = null): ?string

Parameters:

getFromDispatcher

Retrieves the locale from the dispatcher

public getFromDispatcher(?string $default = null): ?string

Parameters:

getFromSession

Retrieves the locale from the session

public getFromSession(?string $default = null): ?string

Parameters:

getFromHttp

Retrieves the locale from the request of getBestLanguage() header or HTTP_ACCEPT_LANGUAGE header

public getFromHttp(?string $default = null): ?string

Parameters:

saveIntoSession

Save locale into session if mode contain session handling

public saveIntoSession(?string $locale = null, bool $force = false): void

Parameters:

lookup

public lookup(string|null $locale = null, array|null $allowed = null, bool $canonicalize = false, string|null $default = null): string|null

Parameters:

Return Value:

The closest matching language tag or default value.

Inherited methods

__construct

Constructs a new instance of the class.

public __construct(array|null $options = null): mixed

Parameters:

initializeOptions

Initializes the options for the object.

public initializeOptions(array|null $options = null): void

Parameters:

initialize

Initializes the object.

public initialize(): void

This method is responsible for performing any necessary setup or initialization tasks for the object. It does not accept any parameters and does not return a value.

setOptions

Sets the options for the object.

public setOptions(array $options, bool $merge = false): void

Parameters:

getOptions

Retrieves all options.

public getOptions(): array

Return Value:

An array containing all the options.

setOption

Sets the value of the option specified by the given key.

public setOption(string $key, mixed $value = null, bool $merge = false): void

Parameters:

getOption

Retrieves the value of the option specified by the given key.

public getOption(string $key, mixed $default = null): mixed

Parameters:

Return Value:

The value of the option specified by the key, or the default value if the option does not exist.

hasOption

Checks if the option specified by the given key exists.

public hasOption(string $key): bool

Parameters:

Return Value:

Returns true if the option exists, false otherwise.

removeOption

Remove an option by key

public removeOption(string $key): void

Removes the option with the given key from the options array.

Parameters:

resetOptions

Reset all options to their default values - Uses the defaultOptions property to set the options

public resetOptions(): void

clearOptions

Clear all options

public clearOptions(): void

This method clears all the options stored in the class. After calling this method, the options array will be empty.