Munenori Sugimura

NAME

Mojolicious::Plugin::LocaleTextDomainOO - I18N(GNU getext) for Mojolicious.

SYNOPSIS

  # Mojolicious
  $self->plugin('LocaleTextDomainOO');

  # Mojolicious::Lite
  plugin 'LocaleTextDomainOO';

Plugin configuration

  # your app in startup method
  sub startup {
      # setup plugin
      $self->plugin('LocaleTextDomainOO',
        {
            file_type => 'po',              # or 'mo'. default: po
            default => 'ja',                # default en
            plugins => [                    # more Locale::TextDomain::OO plugins.
                qw/ +Your::Special::Plugin  # default Expand::Gettext::DomainAndCategory plugin onry.
            /],
            languages => [ qw( en-US en ja-JP ja de-DE de ) ],

            # Mojolicious::Plugin::I18N like options
            no_header_detect => $boolean,               # option. default: false
            support_url_langs => [ qw( en ja de ) ],    # option
            support_hosts => {                          # option
                'mojolicious.ru' => 'ru',
                'mojolicio.us' => 'en'
            }
        }
      );

      # loading lexicon files
      $self->lexicon(
          {
              search_dirs => [qw(/path/my_app/locale)],
              gettext_to_maketext => $boolean,              # option
              decode => $boolean,                           # option
              data   => [ '*::' => '*.po' ],
          }
      );
    ...
  }

DESCRIPTION

Locale::TextDomain::OO is a internationalisation(I18N) tool of perl OO interface. Mojolicious::Plugin::LocaleTextDomainOO is internationalization plugin for Mojolicious.

This module is similar to Mojolicious::Plugin::I18N. But, Locale::MakeText is not using "text domain" and more...

OPTIONS

file_type

    plugin LocaleTextDomainOO => { file_type => 'po' };

Gettext lexicon File type. default to po.

default

    plugin LocaleTextDomainOO => { default => 'ja' };

Default language. default to en.

languages

    plugin LocaleTextDomainOO => { languages => [ 'en-US', 'en', 'ja-JP', 'ja' ] };

plugins

    plugin LocaleTextDomainOO => { plugins => [ qw /Your::LocaleTextDomainOO::Plugin/ ] };

Add plugin. default using Locale::TextDomain::OO::Plugin::Expand::Gettext::DomainAndCategory and Locale::TextDomain::OO::Plugin::Language::LanguageOfLanguages plugin onry.

support_url_langs

    plugin LocaleTextDomainOO => { support_url_langs => [ 'en', 'ja', 'de' ] };

Detect language from URL. see Mojolicious::Plugin::I18N option.

support_hosts

    plugin LocaleTextDomainOO => { support_hosts => { 'mojolicious.ru' => 'ru', 'mojolicio.us' => 'en' } };

Detect Host header and use language for that host. see Mojolicious::Plugin::I18N option.

no_header_detect

    plugin LocaleTextDomainOO => { no_header_detect => 1 };

Off header detect. see Mojolicious::Plugin::I18N option.

HELPERS

locale

    # Mojolicious Lite
    my $loc = app->locale;

Returned Locale::TextDomain::OO object.

lexicon

    app->lexicon(
        {
            search_dirs => [qw(your/my_app/locale)],
            gettext_to_maketext => $boolean,
            decode => $boolean,                         # default true. *** utf8 flaged ***
            data   => [
                '*::' => '*.po',
                '*:CATEGORY:DOMAIN' => '*/test.po',
            ],
        }
    );

Gettext '*.po' or '*.mo' file as lexicon. See Locale::TextDomain::OO::Lexicon::File::PO Locale::TextDomain::OO::Lexicon::File::MO

language

    app->language('ja');
    my $language = app->language;

Set or Get language.

__, __x, __n, __nx

    # In controller
    app->__('hello');
    app->__x('hello, {name}', name => 'World');

    # In template
    <%= __ 'hello' %>
    <%= __x 'hello, {name}', name => 'World' %>

See Locale::TextDomain::OO::Plugin::Expand::Gettext

__p, __px, __np, __npx

    # In controller
    app->__p(
        'time',  # Context (msgctxt)
        'hello'
    );

    # In template
    <%= __p 'time', 'hello' %>

See Locale::TextDomain::OO::Plugin::Expand::Gettext

N__, N__x, N__n, N__nx, N__p, N__px, N__np, N__npx

See Locale::TextDomain::OO::Plugin::Expand::Gettext

__begin_d, __end_d, __d, __dn, __dp, __dnp, __dx, __dnx, __dpx, __dnpx

    # In controller
    app->__d(
        'domain',  # Text Domain
        'hello'
    );

    # In template
    <%= __d 'domain', 'hello' %>

See Locale::TextDomain::OO::Plugin::Expand::Gettext::DomainAndCategory

N__d, N__dn, N__dp, N__dnp, N__dx, N__dnx, N__dpx, N__dnpx

See Locale::TextDomain::OO::Plugin::Expand::Gettext::DomainAndCategory

METHODS

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

register

  $plugin->register(Mojolicious->new);

Register plugin in Mojolicious application.

DEBUG MODE

    # debug mode on
    BEGIN { $ENV{MOJO_I18N_DEBUG} = 1 }

    # or
    MOJO_I18N_DEBUG=1 perl script.pl

AUTHOR

Munenori Sugimura <clicktx@gmail.com>

SEE ALSO

Locale::TextDomain::OO, Mojolicious, Mojolicious::Guides, http://mojolicious.org.

LICENSE

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

LICENSE of Mojolicious::Plugin::I18N

Mojolicious::Plugin::LocaleTextDomainOO uses Mojolicious::Plugin::I18N code. Here is LICENSE of Mojolicious::Plugin::I18N

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.