/ 
Locale-Maketext-Utils-0.0.12
River stage one • 3 direct dependents • 4 total dependents
/ Locale::Maketext::Utils

NAME

Locale::Maketext::Utils - Adds some utility functionality and failure handling to Local::Maketext handles

SYNOPSIS

In MyApp/Localize.pm:

  package MyApp::Localize;
  use Locale::Maketext::Utils; 
  use base 'Locale::Maketext::Utils'; 

  our $Encoding = 'utf-8'; # see below
  
  # no _AUTO
  our %Lexicon = (...

Make all the language Lexicons you want. (no _AUTO)

Then in your script:

my $lang = MyApp::Localize->get_handle('fr');

Now $lang is a normal Locale::Maketext handle object but now there are some new methods and failure handling which are described below.

our $Encoding

If you set your class's $Encoding variable the object's encoding will be set to that.

my $enc = $lh->encoding();

$enc is $MyApp::Localize::fr::Encoding || $MyApp::Localize::Encoding || encoding()'s default

our $Onesided

Setting this to a true value treats the class's %Lexicon as one sided. What that means is if the hash's keys and values will be the same (IE your main Lexicon) you can specify it in the key only and leave the value blank.

So instead of a Lexicon entry like this:

q{Hello I love you won't you tell me your name} => q{Hello I love you won't you tell me your name},

You just do:

q{Hello I love you won't you tell me your name} => '',

The advantages are a smaller file, less prone to mistyping or mispasting, and most important of all someone translating it can simply copy it into their module and enter their translation instead of having to remove the value first.

Aliasing

In your package you can create an alias with this:

__PACKAGE__->make_alias($langs, 1);
or
MyApp::Localize->make_alias([qw(en en_us i_default)], 1);

__PACKAGE__->make_alias($langs);
or
MyApp::Localize::fr->make_alias('fr_ca');

Where $langs is a string or a reference to an array of strings that are the aliased language tags.

You must set the second argument to true if __PACKAGE__ is the base class.

The reason is there is no way to tell if the pakage name is the base class or not.

This needs done before you call get_handle() or it will have no effect on your object really.

Ideally you'd put all calls to this in the main lexicon to ensure it will apply to any get_handle() calls.

Alternatively, and at times more ideally, you can keep each module's aliases in them and then when setting your obj require the module first.

METHODS

$lh->print($key, @args);

Shortcut for

print $lh->maketext($key, @args);

$lh->fetch($key, @args);

Alias for

$lh->maketext($key, @args);

$lh->say($key, @args);

Like $lh->print($key, @args); except appends $/ || \n

$lh->get($key, @args);

Like $lh->fetch($key, @args); except appends $/ || \n

$lh->get_base_class()

Returns the base class of the object. So if $lh is a MyApp::Localize::fr object then it returns MyApp::Localize

$lh->get_language_tag()

Returns the real language name space being used, not language_tag()'s "cleaned up" one

$lh->langtag_is_loadable($lang_tag)

Returns 0 if the argument is not a language that can be used to get a handle.

Returns the language handle if it is a language that can be used to get a handle.

$lh->lang_names_hashref()

This returns a hashref whose keys are the language tags and the values are the name of language tag in $lh's native langauge.

It can be called several ways:

  • Give it a list of tags to lookup

    $lh->lang_names_hashref(@lang_tags)

  • Have it search @INC for Base/Class/*.pm's

    $lh->lang_names_hashref() # IE no args

  • Have it search specific places for Base/Class/*.pm's

    local $lh->{'_lang_pm_search_paths'} = \@lang_paths; # array ref of directories
$lh->lang_names_hashref() # IE no args

The module it uses for lookup (Locales::Language) is only required when this method is called.

The module it uses for lookup (Locales::Language) is currently limited to two character codes but we try to handle it gracefully here.

Does not ensure that the tags are loadable, to do that see below.

$lh->loadable_lang_names_hashref()

Exactly the same as $lh->lang_names_hashref() (because it calls that method...) except it only contains tags that are loadable.

Has additional overhead of calling $lh->langtag_is_loadable() on each key. So most likely you'd use this on a single specific place (a page to choose their language setting for instance) instead of calling it on every instance your script is run.

$lh->append_to_lexicons( $lexicons_hashref );

This method allows modules or script to append to the object's Lexicons

Each key is the language tag whose Lexicon you will prepend its value, a hashref, to.

So assuming the key is 'fr', then this is the lexicon that gets appended to:

__PACKAGE__::fr::Lexicon

The only exception is if the key is '_'. In that case the main package's Lexicon is appended to:

__PACKAGE__::Lexicon

$lh->append_to_lexicons({
    '_' => {
        'Hello World' => 'Hello World',
    },
    'fr' => {
        'Hello World' => 'Bonjour Monde',
    }, 
});

$lh->remove_key_from_lexicons($key)

Removes $key from every lexicon. What is removed is stored in $lh->{'_removed_from_lexicons'}

If defined, $lh->{'_removed_from_lexicons'} is a hashref whose keys are the index number of the $lh->_lex_refs() arrayref.

The value is the key and the value that that lexicon had.

This is used internally to remove _AUTO keys so that the failure handler below will get used

Automatically _AUTO'd Failure Handling with hooks

This module sets fail_with() so that failure is handled for every Lexicon you define as if _AUTO was set and in addition you can use the hooks below.

This functionality is turned off if:

  • _AUTO is set on the Lexicon (and it was not removed internally for some strange reason)

  • you've changed the failure function with $lh->fail_with() (If you do change it be sure to restore your _AUTO's inside $lh->{'_removed_from_lexicons'})

The result is that a key is looked for in the handle's Lexicon, then the default Lexicon, then the handlers below, and finally the key itself (Again, as if _AUTO had been set on the Lexicon). I find this extremely useful and hope you do as well :)

$lh->{'_get_key_from_lookup'}

If lookup fails this code reference will be called with the arguments ($lh, $key, @args)

It can do whatever you want to try and find the $key and return the desired string.

return $string_from_db;

If it fails it should simply:

return;

That way it will continue on to the part below:

$lh->{'_log_phantom_key'}

If $lh->{'_get_key_from_lookup'} is not a code ref, or $lh->{'_get_key_from_lookup'} returned undef then this method is called with the arguments ($lh, $key, @args) right before the failure handler does its _AUTO wonderfulness.

numf() decimal length support/sprintf format

numf() will behave exactly the same as it always has except now it take an additional argument.

This additional argument will describe how to handle any decimal or format via sprintf

Normally this is what happens:

$lh->maketext("pi is [numf,_1]",355/113); #  3.14159

An empty string value will leave the decimals as they are:

$lh->maketext("pi is [numf,_1,_2]",355/113,''); #  3.14159292035398

A zero will remove the decimal character and decimal numbers completely.

Any other number will truncate it (without rounding) to the length given

$lh->maketext("pi is [numf,_1,_2]",355/113,6); # 3.141592

A non-numeric value is used as a sprintf format (which does some rounding)

$lh->maketext("pi is just under [numf,_1,%.3f]",355/113) # 3.142

It'd be great if this were the default and I've proposed it at http://rt.cpan.org/Ticket/Display.html?id=36136

Argument range in bracket notation

Note: this behavior is experimental and should not be used in production yet. Keep reading if you want to find out why.

If you want to operate on several arguments there are currently only 2 options:

know the amount of arguments ahead of time
[method,_2,_3,_4]
use all the arguments
[method,_*]

What if you won't know the length of arguments ahead of time or only want to operate on some, for example with "list"() or "join"()?

You'd use this range notation:

[_1] [method,_2.._4] 

[_1] [method,_2.._#]

_# is the last item in the list, outside of '..' range notation you have to use _-1 not _#

Like _* 0 is not used so:

[method,_-1.._#], qw(a b c d) becomes d,a,b,c,d not 'd,OBJ-stringified-from-zero,a,b,c

Like perl's range operator if both side are the same its a list with 1 item.

'[_1.._#]', 1,2 becomes '12'

'[_1.._#]', 1 becomes '1'

Also if they are an invalid range you get an empty list

'[_2.._1]', qw(a b) # no-op just like for(2..1)

This is for proof of concept only as the way it currently happens changes the lookup key which defeats the purpose.

For technical reasons it can not be done easily by overriding one method, it requires changes in the middle of several

It'd be great if this were the default and I've proposed it at http://rt.cpan.org/Ticket/Display.html?id=37955

Additional bracket notation methods

join()

Joins the given arguments with the first argument:

[join,-,_*], @numbers becomes 1-2-3-4-5
[join,,_*], @numbers becomes 12345
[join,~,,_*], @numbers becomes 1,2,3,4,5
[join,~, ,_*], @numbers becomes 1, 2, 3, 4, 5

list()

Creates a phrased list "and/or" style:

You chose [list,and,_*], @pals

You chose Rhiannon
You chose Rhiannon and Parker
You chose Rhiannon, Parker, and Char
You chose Rhiannon, Parker, Char, and Bean

The 'and' above is by default an '&':

You chose [list,,_*]

You chose Rhiannon, Parker, & Char

A locale can set that but I recommend being explicit in your lexicons so the translators will know what you're trying to say:

[list,and,_*]
[list,or,_*]

A locale can also control the seperator and "oxford" comma character (IE empty string for no oxford comma)

The locale can do this by setting some variables in the same manner you'd set 'numf_comma' to change how numf() behaves for a class without having to write an almost identical method.

The variables are (w/ defaults shown):

$lh->{'list_seperator'}   = ', ';
$lh->{'oxford_seperator'} = ',';
$lh->{'list_default_and'} = '&';

datetime()

Allows you to get datetime output formatted for the current locale.

'Right now it is [datetime]'

It can take 2 arguments which default to DateTime->now and 'long_date_format' respectively.

The first argument tells the function what point in time you want. The values can be:

A DateTime object
A hashref of arguments suitable for DateTime->new()
An epoch suitable for DateTime->from_epoch()'s 'epoch' field.

Uses UTC as the time zone

A time zone suitable for DateTime constructors' 'time_zone' field

The current time is used.

Passing it an empty string will result in UTC being used.

An epoch and time zone as above joined together by a colon

A colon followed by nothing will result in UTC

The second tells it what format you'd like that point in time stringified. The values can be:

A coderef that returns a string suitable for DateTime->strftime()
A string that is the name of a DateTime::Locale method
A string suitable for DateTime->strftime()

format_bytes()

Shortcut to Number::Bytes::Human format_bytes()

'You have used [format_bytes,_1] of your alloted space', $bytes

convert()

Shortcut to Math::Units convert()

'The fish was [convert,_1,_2,_3]" long', $feet,'ft','in'

Project example

Main Class:

package MyApp::Localize;
use Locale::Maketext::Utils; 
use base 'Locale::Maketext::Utils'; 

our $Onesided = 1;
our $Encoding = 'utf-8'; 

__PACKAGE__->make_alias([qw(en en_us i_default)], 1);

our %Lexicon = (
    'Hello World' => '',
);

1;

French class:

package MyApp::Localize::fr;
use base 'MyApp::Localize';

__PACKAGE__->make_alias('fr_ca');

our %Lexicon = (
    'Hello World' => 'Bonjour Monde',
);

sub init {
    my ($lh) = @_;
    $lh->SUPER::init();
    $lh->{'numf_comma'} = 1; # Locale::Maketext numf()
    return $lh;
}

1;

ENVIRONMENT

$ENV{'maketext_obj'} gets set to the language object on initialization ( for functions to use, see "FUNCTIONS" below ) unless $ENV{'maketext_obj_skip_env'} is true

FUNCTIONS

All are exportable, each takes the same args as the method of the same name (sans 'env_') and each uses $ENV{'maketext_obj'} if valid or it uses a Local::Maketext::Pseudo object.

env_maketext()
env_fetch()
env_print()
env_get()
env_say()

SEE ALSO

Locale::Maketext, Locales::Language, Locale::Maketext::Pseudo

TODO

Better drop in modular lexicon support/documentation

Specific support of lexicon management w/ non-hash based lexicons

Add in currently beta datetime_duration() ("LOCALIZATION of DateTime::Format modules" in DateTime::Format::Span and company)

Add in currently beta currency(), currency_convert()

possibly some formatters (would need to associate an output object of some kind though...)

SUGGESTIONS

If you have an idea for a method that would fit into this module just let me know and we'll see what can be done

AUTHOR

Daniel Muey, http://drmuey.com/cpan_contact.pl

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Daniel Muey

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 775:

'=item' outside of any '=over'