|
Packit |
f3e6b9 |
=pod
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 NAME
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
Locale::Country - module for dealing with country code sets
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 SYNOPSIS
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
use Locale::Country;
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
$name = code2country(CODE);
|
|
Packit |
f3e6b9 |
$code = country2code(NAME);
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
@codes = all_country_codes();
|
|
Packit |
f3e6b9 |
@names = all_country_names();
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 DESCRIPTION
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
This module provides access to country code sets.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
Please refer to the L<Locale::Codes::Types> document for a description
|
|
Packit |
f3e6b9 |
of the code sets available.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
Most of the routines take an optional additional argument which
|
|
Packit |
f3e6b9 |
specifies the code set to use. The code set can be specified using the
|
|
Packit |
f3e6b9 |
name of a code set, or the perl constant specified in the above
|
|
Packit |
f3e6b9 |
document. If not specified, the default code set will be used.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 ROUTINES
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
All routines in this module call the appropriate method in the
|
|
Packit |
f3e6b9 |
L<Locale::Codes> module, using an object of type: country
|
|
Packit |
f3e6b9 |
Please refer to the documentation of the L<Locale::Codes> module
|
|
Packit |
f3e6b9 |
for details about each function.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
The following functions are exported automatically:
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=over 4
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<code2country(CODE [,CODESET] [,'retired'])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<code2name> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<country2code(NAME [,CODESET] [,'retired'])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<name2code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<country_code2code(CODE ,CODESET ,CODESET2)>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<code2code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<all_country_codes([CODESET] [,'retired'])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<all_codes> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<all_country_names([CODESET] [,'retired'])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<all_names> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=back
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
The following functions are not exported and must be called fully
|
|
Packit |
f3e6b9 |
qualified with the package name:
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=over 4
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::show_errors(FLAG)>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
By default, invalid input will produce empty results, but no errors. By
|
|
Packit |
f3e6b9 |
passing in a non-zero value of FLAG, errors will be produced.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<show_errors> in L<Locale::Codes> but note that the default for
|
|
Packit |
f3e6b9 |
the non-OO modules are to NOT produce errors.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::rename_country(CODE ,NEW_NAME [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<rename_code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::add_country(CODE ,NAME [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<add_code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::delete_country(CODE [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<delete_code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::add_country_alias(NAME ,NEW_NAME)>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<add_alias> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::delete_country_alias(NAME)>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<delete_alias> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::rename_country_code(CODE ,NEW_CODE [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<replace_code> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::add_country_code_alias(CODE ,NEW_CODE [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<add_code_alias> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item B<Locale::Country::delete_country_code_alias(CODE [,CODESET])>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See B<delete_code_alias> in L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=back
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 SEE ALSO
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=over 4
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=item L<Locale::Codes>
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
The Locale-Codes distribution.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=back
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 AUTHOR
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
See Locale::Codes for full author history.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
Currently maintained by Sullivan Beck (sbeck@cpan.org).
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=head1 COPYRIGHT
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
Copyright (c) 2011-2018 Sullivan Beck
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
This module is free software; you can redistribute it and/or
|
|
Packit |
f3e6b9 |
modify it under the same terms as Perl itself.
|
|
Packit |
f3e6b9 |
|
|
Packit |
f3e6b9 |
=cut
|