NAME

DateTime::Format::Human - Format times in "spoken language"

SYNOPSIS

    use DateTime;
    use DateTime::Format::Human;

    my $dtfh = DateTime::Format::Human->new(
        evening => 19,
        night   => 23,
    );

    my $spoken_time = $dtfh->format_datetime( DateTime->now );

    print "The time is now $spoken_time\n";

DESCRIPTION

This module provides a "vague" rendering of the time into natural language; it's originally intended for text-to-speech applications and other speech-based interfaces.

USAGE

Import Parameters

This module accepts no arguments to it's import method and exports no symbols.

Methods

Constructors

new(...)
Accepts a optional hash and returns a the DateTime::Format::Human manpage object.
```
    my $dtfh = DateTime::Format::Human->new(
        evening => 19,
        night   => 23,
    );
```
- evening
  Sets the hour at which afternoon turns to evening.
  
  This key defaults to the value of 18.
- night
  Sets the hour at which evening turns to night.
  
  This key defaults to the value of 22.

Object Methods

format_datetime
Accepts a DateTime object.

Returns a string representing the time in spoken human language.

CREDITS

Simon Cozens (SIMON) who wrote the Time::Human manpage from which this module is a genetic descendant.

Everyone at the DateTime Asylum.

SUPPORT

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

AUTHOR

Joshua Hoblitt <jhoblitt@cpan.org>

COPYRIGHT

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, or in perlartistic and perlgpl Pods as supplied with Perl 5.8.1 and later.