view release on metacpan or  search on metacpan

lib/App/TimelogTxt/Utils.pm  view on Meta::CPAN

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

=head2 fmt_time( $time )

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

=head2 is_datestamp( $stamp )

Returns C<true> if C<$stamp> is a properly formatted datestamp.

=head2 is_today( $day_str )

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

=head2 is_stop_cmd( $task )

Returns C<true> if the supplied C<$task> is equal to the C<STOP_CMD> constant.

=head2 has_project( $task )

Returns C<true> if the supplied C<$task> has a project entry.

=head2 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.

=head2 stamp_to_localtime( $stamp )

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

=head2 STOP_CMD()

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

=head2 TODAY()

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

=head2 today_stamp()

Return the datestamp for today.

=head1 CONFIGURATION AND ENVIRONMENT

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

=head1 DEPENDENCIES

POSIX, Time::Local.

=head1 INCOMPATIBILITIES

None reported.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

=head1 AUTHOR

G. Wade Johnson  C<< gwadej@cpan.org >>

=head1 LICENCE AND COPYRIGHT

Copyright (c) 2013, G. Wade Johnson C<< 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 L<perlartistic>.


=head1 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.