NAME

Astro::App::Satpass2::FormatTime::Strftime - Provide common functionality for strftime-type time formatters.

SYNOPSIS

package MyTimeFormatter;
use Astro::App::Satpass2::FormatTime::Strftime;
use POSIX qw{ strftime };

sub iso8601 {
    my ( $time ) = @_;
    return strftime( ISO_8601_FORMAT, gmtime $time );
}

NOTICE

This package is private to the Astro::App::Satpass2 package. The author reserves the right to revoke it or change it without notice.

DESCRIPTION

This package provides common functionality for strftime-based time formatters. Since the actual implementation may vary, what we really have here is a repository for common formats. These are implemented as manifest constants (i.e. use constant), but are documented below as methods.

MANIFEST CONSTANTS

This class supports the following manifest constants, which are all exported by default:

DATE_FORMAT

This manifest constant returns a date format designed to produce a numeric date in the format year-month-day. Since this format is intended to be used with strftime(), it is '%Y-%m-%d'.

FORMAT_TYPE

This manifest constant returns the type of format expected by the formatter. This class returns 'strftime'.

ISO_8601_FORMAT

This manifest constant returns a date format designed to produce a date and time in ISO 8601 format, in the Universal/GMT time zone. Since this format is intended to be used with strftime(), it is '%Y%m%dT%H%M%SZ'.

TIME_FORMAT

This manifest constant returns a date format designed to produce a time in the format hour:minute:second. Since this format is intended to be used with strftime(), it is '%H:%M:%S'.

SUPPORT

Support is by the author. Please file bug reports at https://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2010-2020 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.