FS/FS/Locales.pm

   1 package FS::Locales;
   2
   3 use strict;
   4 use Tie::IxHash;
   5
   6 =head1 NAME
   7
   8 FS::Locales - Supported locales
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::Locales;
  13
  14   my @locales = FS::Locales->locales;
  15
  16 =head1 DESCRIPTION
  17
  18 FS::Locales provides a list of supported locales.
  19
  20 =head1 CLASS METHODS
  21
  22 =over 4
  23
  24 =item locales
  25
  26 Returns a list of the available locales.
  27
  28 =cut
  29
  30 tie our %locales, 'Tie::IxHash',
  31   'en_US', { name => 'English',        country => 'United States', },
  32   'en_AU', { name => 'English',        country => 'Australia', },
  33   'en_CA', { name => 'English',        country => 'Canada', },
  34   'es_ES', { name => 'Spanish',        country => 'Spain', },
  35   'es_CU', { name => 'Spanish',        country => 'Cuba', },
  36   'es_MX', { name => 'Spanish',        country => 'Mexico', },
  37   'es_PA', { name => 'Spanish',        country => 'Panama', },
  38   'es_US', { name => 'Spanish',        country => 'United States', },
  39   'fr_CA', { name => 'French',         country => 'Canada', },
  40   'fr_FR', { name => 'French',         country => 'France', },
  41   'fr_HT', { name => 'French',         country => 'Haiti', },
  42   'ht_HT', { name => 'Haitian Creole', country => 'Haiti', },
  43   'iw_IL', { name => 'Hebrew',         country => 'Israel', rtl=>1, },
  44 ;
  45
  46 $_->{label} = $_->{name} . ' (' . $_->{country} . ')'
  47   foreach values %locales;
  48
  49 sub locales {
  50   keys %locales;
  51 }
  52
  53 =item locale_info LOCALE
  54
  55 Returns a hash of information about a locale.
  56
  57 =cut
  58
  59 sub locale_info {
  60   my($class, $locale) = @_;
  61   if (!$locale) {
  62     return ();
  63   } elsif (exists $locales{$locale}) {
  64     return %{ $locales{$locale} };
  65   } else {
  66     die "unsupported locale '$locale'\n";
  67   }
  68 }
  69
  70 =item description LOCALE
  71
  72 Returns "Language (Country)" for a locale.
  73
  74 =cut
  75
  76 sub description {
  77   my($class, $locale) = @_;
  78   $locales{$locale}->{'name'} . ' (' . $locales{$locale}->{'country'} . ')';
  79 }
  80
  81 =back
  82
  83 =head1 BUGS
  84
  85 =head1 SEE ALSO
  86
  87 L<FS::Msgcat>
  88
  89 =cut
  90
  91 1;
  92