G. Wade Johnson > App-TimelogTxt-0.12 > App::TimelogTxt::Event

Download:
App-TimelogTxt-0.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.12   Source  

NAME ^

App::TimelogTxt::Event - Class representing an event to log.

VERSION ^

This document describes ModName version 0.12

SYNOPSIS ^

    use App::TimelogTxt::Event;

    my @events;
    while(<>)
    {
        my $event = App::TimelogTxt::Event->new_from_line( $_ );
        if( $event->stamp eq $wanted_stamp )
        {
            push @events, $event;
        }
    }

DESCRIPTION ^

Objects of this class represent the individual lines in the timelog.txt file. Each event has a date and time stamp, an optional project, and a task.

INTERFACE ^

new( $task, $time )

Create a new object representing the supplied $task at the supplied epoch $time. If no $time is supplied, use the current time.

new_from_line( $line )

Create a new object representing the event from the supplied line. This event must be formatted as described in App::TimelogTxt::Format.

$event->task()

Return a string containing all of the event except the time and date.

$event->project()

Return the string designated as the project, if any, from the event.

$event->to_string()

Return a string representing the event, formatted as described in App::TimelogTxt::Format.

$event->epoch()

Return the time for the start of the event in epoch seconds.

$event->stamp()

Return the date stamp of the event in 'YYYY-MM-DD' format.

$event->is_stop()

Return true if this was a stop event.

CONFIGURATION AND ENVIRONMENT ^

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

DEPENDENCIES ^

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.

syntax highlighting: