PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

internal package Foswiki::I18N

Support for strings translation and language detection.

ClassMethod available_languages

Lists languages tags for languages available at Foswiki installation. Returns a list containing the tags of the available languages.

Note: the languages available to users are determined in the configure interface.

ClassMethod new ( $session )

Constructor. Gets the language object corresponding to the current users language. If $session is not a Foswiki object reference, just calls Local::Maketext::new (the superclass constructor)

ObjectMethod finish()

Break circular references.

ObjectMethod maketext( $text ) → $translation

Translates the given string (assumed to be written in English) into the current language, as detected in the constructor, and converts it into a binary UTF-8 string.

Wraps around Locale::Maketext's maketext method, adding charset conversion and checking.

Return value: translated string, or the argument itself if no translation is found for thet argument.

ObjectMethod language() → $language_tag

Indicates the language tag of the current user's language, as detected from the information sent by the browser. Returns the empty string if the language could not be determined.

ObjectMethod enabled_languages() → %languages

Returns an array with language tags as keys and language (native) names as values, for all the languages enabled in this site. Useful for listing available languages to the user.