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_CA', { name => 'English',        country => 'Canada', },
  33   'fr_CA', { name => 'French',         country => 'Canada', },
  34   'fr_FR', { name => 'French',         country => 'France', },
  35   'fr_HT', { name => 'French',         country => 'Haiti', },
  36   'ht_HT', { name => 'Haitian Creole', country => 'Haiti', },
  37   'iw_IL', { name => 'Hebrew',         country => 'Israel', rtl=>1, },
  38 ;
  39
  40 sub locales {
  41   keys %locales;
  42 }
  43
  44 =item locale_info LOCALE
  45
  46 Returns a hash of information about a locale.
  47
  48 =cut
  49
  50 sub locale_info {
  51   my($class, $locale) = @_;
  52   %{ $locales{$locale} };
  53 }
  54
  55 =item description LOCALE
  56
  57 Returns "Language (Country)" for a locale.
  58
  59 =cut
  60
  61 sub description {
  62   my($class, $locale) = @_;
  63   $locales{$locale}->{'name'} . ' (' . $locales{$locale}->{'country'} . ')';
  64 }
  65
  66 =back
  67
  68 =head1 BUGS
  69
  70 =head1 SEE ALSO
  71
  72 L<FS::Msgcat>
  73
  74 =cut
  75
  76 1;
  77