/ 
DateTime-Locale-0.05
River stage four • 26 direct dependents • 3978 total dependents
/ DateTime::Locale::Base

NAME

DateTime::Locale::Base - Base class for individual locale objects

SYNOPSIS

use base 'DateTime::Locale::Base';

SUPPORT

Support for this module is provided via the datetime@perl.org email list. See http://lists.perl.org/ for more details.

DEFAULT FORMATS

Each locale has a set of four default date and time formats. They are distinguished by length, and are called "full", "long", "medium", and "short". Each locale may have a different default length which it uses when its default_date_format(), default_time_format(), or default_datetime_format() methods are called.

This can be changed by calling the set_default_date_format() or set_default_time_format() methods. These methods accept a string which must be one of "full", "long", "medium", or "short".

SUBCLASSING

If you are writing a subclass of this class, then you must provide the following methods:

  • month_names

    Returns an array reference containing the full names of the months, with January as the first month.

  • month_abbreviations

    Returns an array reference containing the abbreviated names of the months, with January as the first month.

  • day_names

    Returns an array reference containing the full names of the days, with Monday as the first day.

  • day_abbreviations

    Returns an array reference containing the abbreviated names of the days, with Monday as the first day.

  • am_pms

    Returns an array reference containing the localized forms of "AM" and "PM".

  • date_formats

    Returns a hash reference containing the date formats used for the locale. The hash must contain the keys "long", "full", "medium", and "short".

  • time_formats

    Returns a hash reference containing the time formats used for the locale. The hash must contain the keys "long", "full", "medium", and "short".

  • date_before_time

    This returns a boolean value indicating whether or not the date comes before the time when formatting a complete date and time for presentation.

  • date_parts_order

    This returns a string indicating the order of the parts of a date that is in the form XX/YY/ZZ. The possible values are "dmy", "mdy", "ydm" and "ymd".

  • _default_date_format_length

    This should return a string which is one of "long", "full", "medium", or "short". It indicates the default date format length for the locale.

  • _default_time_format_length

    This should return a string which is one of "long", "full", "medium", or "short". It indicates the default time format length for the locale.

AUTHORS

Richard Evans <rich@ridas.com>

Dave Rolsky <autarch@urth.org>

COPYRIGHT

Copyright (c) 2003 Richard Evans. All rights reserved.

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

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