Mojolicious::Plugin::I18N(3p)

NAME
Mojolicious::Plugin::I18N - Internationalization plugin

SYNOPSIS
  # Mojolicious
  $self->plugin('I18N');
  % languages 'de';
  %=l 'hello'

  # Mojolicious::Lite
  plugin I18N => {namespace => 'MyApp::I18N'};
  %=l 'hello'

  # Lexicon
  package MyApp::I18N::de;
  use Mojo::Base 'MyApp::I18N';

  our %Lexicon = (hello => 'hallo');

  1;

DESCRIPTION
Mojolicious::Plugin::I18N adds Locale::Maketext support to Mojolicious. All you have to do besides using this plugin is to add as many lexicon classes as you need. Languages can usually be detected automatically from the "Accept-Languages" request header.

This plugin can save a lot of typing, since it will generate the following code by default.

  # $self->plugin('I18N');
  package MyApp::I18N;
  use base 'Locale::Maketext';
  package MyApp::I18N::en;
  use base 'MyApp::I18N';
  our %Lexicon = (_AUTO => 1);
  1;

Namespace and default language of generated code are affected by their respective options. The default lexicon class will only be generated if it doesn't already exist.

OPTIONS
Mojolicious::Plugin::I18N supports the following options.

  "default"
  # Mojolicious::Lite
  plugin I18N => {default => 'en'};

Default language, defaults to "en".

  "namespace"
  # Mojolicious::Lite
  plugin I18N => {namespace => 'MyApp::I18N'};

Lexicon namespace, defaults to the application class followed by "::I18N".

HELPERS
Mojolicious::Plugin::I18N implements the following helpers.

  "l"
  %=l 'hello'
  $self->l('hello');

Translate sentence.

  "languages"
  % languages 'de';
  $self->languages('de');

Change languages.

METHODS
Mojolicious::Plugin::I18N inherits all methods from Mojolicious::Plugin and implements the following new ones.

  "register"
  $plugin->register;

Register plugin hooks and helpers in Mojolicious application.

SEE ALSO
Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.