/ 
DateTimeX-Period-0.01
River stage zero No dependents
/ DateTimeX::Period

NAME

DateTimeX::Period - simple subclass of DateTime, which provides simple methods to work in period context such as a day.

VERSION

Version 0.01

SYNOPSIS

use DateTime::TimeZone qw();
use DateTimeX::Period qw();

my $dt = DateTimeX::Period->from_epoch(
	epoch => time(),
	time_zone => DateTime::TimeZone->new( name => 'local' )->name()
);
my $interval_start = $dt->get_start('month');
my $interval_end   = $dt->get_end('month');

METHODS

get_start($period)

Returns DateTime object with the start of the given period.

The start date/time depends in which context period is provided: - if it's a day, than midnight of that day - if it's a week, than Monday at midnight of that week - if it's a month, than 1st day at midnight of that month - and etc.

get_end($period)

Returns DateTime object with end of the given period, which is same as start of the next period.

The end date/time depends in which context period is provided: - if it's a day, than midnight of the next day - if it's a week, than Monday at midnight of the following week - if it's a month, than 1st day at midnight of the following month - and etc.

In cases where midnight does not exist, the start of those periods are not at midnight, but this should not affect the end of the period, which is the same as the start of the next period. if it happens to be not at midnight, which might happen in case of 'day', 'week' or 'month' try to truncate, if it fails gracefully fallback to another algorithm.

get_period_keys()

Returns all period keys in preserved order.

get_period_label($key)

Returns period label.

_get_start_of_the_day($dt)

internal subroutine to get the start of the day. This assumes DST does not happen at 12 midday.

CAVEATS

In timezones such as America/Sao_Paulo, Asia/Beirut, Asia/Damascus etc. etc. DST happens at midnight. For these occassions, library falls back to another algorithm for calculating start/end of interval. On these occasions assumption is made that in those timezones DST will never happen at 12am and again at 12pm ( see _get_start_of_the_day subroutine ).

Start of the week is always Monday.

AUTHOR

Vytas Dauksa, <vytas.dauksa at smoothwall.net>

BUGS

Please report any bugs or feature requests to bug-datetimex-period at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=DateTimeX-Period. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc DateTimeX::Period

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Smoothwall.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.