Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

i18n::acceptlanguage(3pm) [debian man page]

I18N::AcceptLanguage(3pm)				User Contributed Perl Documentation				 I18N::AcceptLanguage(3pm)

NAME

       I18N::AcceptLanguage - Matches language preference to available languages

SYNOPSIS

	 use I18N::AcceptLanguage;

	 my $supportedLanguages = [( 'en-us', 'fr' )];

	 my $acceptor = I18N::AcceptLanguage->new();
	 my $language = $acceptor->accepts($ENV{HTTP_ACCEPT_LANGUAGE},
					   $supportedLanguages);

DESCRIPTION

       I18N::AcceptLanguage matches language preference to available languages per rules defined in RFC 2616, section 14.4: HTTP/1.1 - Header
       Field Definitions - Accept-Language.

PUBLIC METHODS

       accepts( CLIENT_PREFERENCES, SUPPORTED_LANGUAGES )
	 Returns the highest priority common language between client and server. If no common language is found, the defaultLanguage is returned.
	 If defaultLanuage is also not set, an empty string is returned. The method expects two arguments:

	 CLIENT_PREFERENCES
	   A string in the same format defined in RFC 2616, quoted here:

	     1#( ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" ) [ "'" "q" "=" qvalue ] )

	   Examples:

	     da, en-gb;q=0.8, en;q=0.7

	     en-us, ja, *

	 SUPPORTED_LANGUAGES
	   A reference to a list of language ranges supported by the server.

       new( [ OPTIONS ] )
	 Returns a new I18N::AcceptLanguage object. The method accepts the following key/value pair options:

	 debug
	   A boolean set to either 0 or 1. When set to 1, debug messages will be printed to STDOUT. The value of debug defaults to 0.

	 defaultLanguage
	   A string representing the server's default language choice. The value of defaultLanguage defaults to an empty string.

	 strict
	   A boolean set to either 0 or 1. When set to 1, the software strictly conforms to the protocol specification. When set to 0, the soft-
	   ware will perform a secondary, aggressive language match regardless of country (ie, a client asking for only en-gb will get back en-us
	   if the server does not accept en-gb or en but does accept en-us). The last matching language in the supported languages list will be
	   chosen. The value of strict defaults to 1.

PRIVATE METHODS

       debug( [ BOOLEAN ] )
	 A get/set method that returns the value of debug, set by the optional method argument.

       defaultLanguage( [ LANGUAGE ] )
	 A get/set method that returns the value of defaultLanguage, set by the optional method argument.

       strict( [ BOOLEAN ] )
	 A get/set method that returns the value of strict, set by the optional method argument.

NOTES

       Case Sensitivity
	 Language matches are done in a case-insensitive manner but results are case-sensitive to the value found in the SUPPORTED_LANGUAGES list.

AVAILABILITY

       This module is available on CPAN worldwide and requires perl version 5.6.1 or higher be installed.

AUTHORS

       Christian Gilmore <cag@us.ibm.com>

SEE ALSO

       RFC 2616

COPYRIGHT

       Copyright (C) 2003, 2004 International Business Machines Corporation and others. All Rights Reserved.

       This module is free software; you can redistribute it and/or modify it under the terms of the IBM Public License.

perl v5.8.8							    2005-04-11						 I18N::AcceptLanguage(3pm)

Check Out this Related Man Page

I18N::LangTags::Detect(3pm)				 Perl Programmers Reference Guide			       I18N::LangTags::Detect(3pm)

NAME

       I18N::LangTags::Detect - detect the user's language preferences

SYNOPSIS

	 use I18N::LangTags::Detect;
	 my @user_wants = I18N::LangTags::Detect::detect();

DESCRIPTION

       It is a common problem to want to detect what language(s) the user would prefer output in.

FUNCTIONS

       This module defines one public function, "I18N::LangTags::Detect::detect()".  This function is not exported (nor is even exportable), and
       it takes no parameters.

       In scalar context, the function returns the most preferred language tag (or undef if no preference was seen).

       In list context (which is usually what you want), the function returns a (possibly empty) list of language tags representing (best first)
       what languages the user apparently would accept output in.  You will probably want to pass the output of this through
       "I18N::LangTags::implicate_supers_tightly(...)"	or "I18N::LangTags::implicate_supers(...)", like so:

	 my @languages =
	   I18N::LangTags::implicate_supers_tightly(
	     I18N::LangTags::Detect::detect()
	   );

ENVIRONMENT

       This module looks for several environment variables, including REQUEST_METHOD, HTTP_ACCEPT_LANGUAGE, LANGUAGE, LC_ALL, LC_MESSAGES, and
       LANG.

       It will also use the Win32::Locale module, if it's installed.

SEE ALSO

       I18N::LangTags, Win32::Locale, Locale::Maketext.

       (This module's core code started out as a routine in Locale::Maketext; but I moved it here once I realized it was more generally useful.)

COPYRIGHT

       Copyright (c) 1998-2004 Sean M. Burke. All rights reserved.

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

       The programs and documentation in this dist are distributed in the hope that they will be useful, but without any warranty; without even
       the implied warranty of merchantability or fitness for a particular purpose.

AUTHOR

       Sean M. Burke "sburke@cpan.org"

perl v5.16.3							    2013-03-04					       I18N::LangTags::Detect(3pm)
Man Page