The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-TimelogTxt-0.03_1
River stage zero No dependents
++
/ App::TimelogTxt::Utils

NAME

App::TimelogTxt::Utils - Utility functions for the App::TimelogTxt modules.

VERSION

This document describes App::TimelogTxt::Utils version 0.03_1

SYNOPSIS

    use App::TimelogTxt::Utils;

    my $t = App::TimelogTxt::Utils::stamp_to_localtime( $stamp );
    my $estamp = App::TimelogTxt::Utils::day_end( $stamp );

DESCRIPTION

This module collects a set of utility functions and constants into one place to avoid duplication in multiple modules or odd dependency loops. No effort has been made to have these utility functions be particularly useful to code outside this application.

INTERFACE

canonical_datestamp( $stamp )

Given a date stamp like string that has '/' instead of '-' as separators, convert to standard datestamp form: YYYY-MM-DD.

day_end( $stamp )

Given a properly formated datestamp, find the next datestamp after the one supplied.

day_num_from_name( $day_name )

Given a day name in English, return the day number (0-6).

day_stamp( $day_str )

Return a properly formatted datestamp for the supplied string. This string may be any one of the following:

The empty string or 'today'

Datestamp for today.

'yesterday'

Datestamp for yesterday.

'monday', 'tuesday', etc.

Datestamp for the most recent day named. For example, if today is Wednesday and the string 'tuesday' is supplied, yesterday's datestamp is returned.

A datestamp

The supplied datestamp is returned.

fmt_date( $time )

Return a properly formatted datestamp for the day corresponding to $time in the local timezone.

fmt_time( $time )

Return a properly formatted datestamp plus time corresponding to $time in the local timezone.

is_datestamp( $stamp )

Returns true if $stamp is a properly formatted datestamp.

is_today( $day_str )

Returns true if $day_str is either 'today' or the empty string.

parse_event_line( $line )

Parse the supplied string into the datestamp, time, and the rest of the line, if the string represents a proper event line.

stamp_to_localtime( $stamp )

Convert the datestamp to the last second of the day specified by $stamp in the local timezone.

STOP_CMD()

This constant returns the string 'stop' used throughout the system as to represent the command that stops timing.

TODAY()

This constant returns the string 'today' used throughout the system to represent today.

today_stamp()

Return the datestamp for today.

CONFIGURATION AND ENVIRONMENT

App::TimelogTxt::Utils requires no configuration files or environment variables.

DEPENDENCIES

POSIX, Time::Local.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

AUTHOR

G. Wade Johnson gwadej@cpan.org

LICENCE AND COPYRIGHT

Copyright (c) 2013, G. Wade Johnson gwadej@cpan.org. All rights reserved.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.