Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DateTime::Locale::FromUser(Contributed Perl DocumDateTime::Locale::FromData(3)

NAME
       DateTime::Locale::FromData - Class for locale objects instantiated from
       pre-defined data

VERSION
       version 1.26

SYNOPSIS
	 my $locale = DateTime::Locale::FromData->new(%lots_of_data)

DESCRIPTION
       This class is used to represent locales instantiated from the data in
       the DateTime::Locale::Data module.

METHODS
       This class provides the following methods:

   $locale->code
       The complete locale id, something like "en-US".

   $locale->language_code
       The language portion of the code, like "en".

   $locale->script_code
       The script portion of the code, like "Hant".

   $locale->territory_code
       The territory portion of	the code, like "US".

   $locale->variant_code
       The variant portion of the code,	like "POSIX".

   $locale->name
       The locale's complete name, which always	includes at least a language
       component, plus optional	territory and variant components. Something
       like "English United States". The value returned	will always be in
       English.

   $locale->language
   $locale->script
   $locale->territory
   $locale->variant
       The relevant component from the locale's	complete name, like "English"
       or "United States".

   $locale->native_name
       The locale's complete name in localized form as a UTF-8 string.

   $locale->native_language
   $locale->native_script
   $locale->native_territory
   $locale->native_variant
       The relevant component from the locale's	complete native	name as	a
       UTF-8 string.

   $locale->month_format_wide
   $locale->month_format_abbreviated
   $locale->month_format_narrow
   $locale->month_stand_alone_wide
   $locale->month_stand_alone_abbreviated
   $locale->month_stand_alone_narrow
   $locale->day_format_wide
   $locale->day_format_abbreviated
   $locale->day_format_narrow
   $locale->day_stand_alone_wide
   $locale->day_stand_alone_abbreviated
   $locale->day_stand_alone_narrow
   $locale->quarter_format_wide
   $locale->quarter_format_abbreviated
   $locale->quarter_format_narrow
   $locale->quarter_stand_alone_wide
   $locale->quarter_stand_alone_abbreviated
   $locale->quarter_stand_alone_narrow
   $locale->am_pm_abbreviated
   $locale->era_wide
   $locale->era_abbreviated
   $locale->era_narrow
       These methods all return	an array reference containing the specified
       data.

       The methods with	"format" in the	name should return strings that	can be
       used a part of a	string,	like "the month	of July". The stand alone
       values are for use in things like calendars as opposed to a sentence.

       The narrow forms	may not	be unique (for example,	in the day column
       heading for a calendar it's okay	to have	"T" for	both Tuesday and
       Thursday).

       The wide	name should always be the full name of thing in	question. The
       narrow name should be just one or two characters.

   $locale->date_format_full
   $locale->date_format_long
   $locale->date_format_medium
   $locale->date_format_short
   $locale->time_format_full
   $locale->time_format_long
   $locale->time_format_medium
   $locale->time_format_short
   $locale->datetime_format_full
   $locale->datetime_format_long
   $locale->datetime_format_medium
   $locale->datetime_format_short
       These methods return strings appropriate	for the
       "DateTime->format_cldr" method.

   $locale->format_for($name)
       These are accessed by passing a name to "$locale->format_for(...)",
       where the name is a CLDR-style format specifier.

       The return value	is a string suitable for passing to
       "$dt->format_cldr", so you can do something like	this:

	 print $dt->format_cldr( $dt->locale->format_for('MMMdd') )

       which for the "en" locale would print out something like	"08 Jul".

       Note that the localization may also include additional text specific to
       the locale. For example,	the "MMMMd" format for the "zh"	locale
       includes	the Chinese characters for "day" (aeY) and month (ae), so you
       get something like "8ae23aeY".

   $locale->available_formats
       This should return a list of all	the format names that could be passed
       to "$locale->format_for".

       See the documentation for individual locales for	details	and examples
       of these	formats. The format names that are available vary by locale.

   $locale->glibc_datetime_format
   $locale->glibc_date_format
   $locale->glibc_date_1_format
   $locale->glibc_time_format
   $locale->glibc_time_12_format
       These methods return strings appropriate	for the	"DateTime->strftime"
       method. However,	you are	strongly encouraged to use the other format
       methods,	which use the CLDR format data.	They are primarily included
       for the benefit for DateTime::Format::Strptime.

   $locale->version
       The CLDR	version	from which this	locale was generated.

   $locale->prefers_24_hour_time
       Returns a boolean indicating whether or not the locale prefers 24-hour
       time.

   $locale->first_day_of_week
       Returns a number	from 1 to 7 indicating the local first day of the
       week, with Monday being 1 and Sunday being 7.

   $locale->locale_data
       Returns the original data used to create	this locale as a hash. This is
       here to facilitate creating custom locale that via
       "DateTime::Locale-"register_data_locale>.

SUPPORT
       Bugs may	be submitted at
       <https://github.com/houseabsolute/DateTime-Locale/issues>.

       There is	a mailing list available for users of this distribution,
       <mailto:datetime@perl.org>.

       I am also usually active	on IRC as 'autarch' on "irc://irc.perl.org".

SOURCE
       The source code repository for DateTime-Locale can be found at
       <https://github.com/houseabsolute/DateTime-Locale>.

AUTHOR
       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2003 - 2020 by Dave Rolsky.

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

       The full	text of	the license can	be found in the	LICENSE	file included
       with this distribution.

perl v5.32.0			  2020-07-03	 DateTime::Locale::FromData(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | METHODS | SUPPORT | SOURCE | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DateTime::Locale::FromData&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help