Skip to content
Browse files

Load Business-Hours-0.01 into Business-Hours/trunk.

  • Loading branch information...
1 parent 7d352ca commit 7fc905853f48e69248d909db03f208d3f9a44e26 Somebody at Best Practical committed Nov 16, 2003
Showing with 805 additions and 0 deletions.
  1. +6 −0 Changes
  2. +383 −0 LICENSE
  3. +7 −0 MANIFEST
  4. +11 −0 Makefile.PL
  5. +79 −0 README
  6. +3 −0 Todo
  7. +316 −0 lib/Business/Hours.pm
View
6 Changes
@@ -0,0 +1,6 @@
+Revision history for Perl module Business::Hours
+
+0.01 Tue Feb 11 14:58:20 2003
+ - original version; created by ExtUtils::ModuleMaker 0.31229
+
+
View
383 LICENSE
@@ -0,0 +1,383 @@
+Terms of Perl itself
+
+a) the GNU General Public License as published by the Free
+ Software Foundation; either version 1, or (at your option) any
+ later version, or
+b) the "Artistic License"
+
+---------------------------------------------------------------------------
+
+The General Public License (GPL)
+Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
+Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
+verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software--to make sure the
+software is free for all its users. This General Public License applies to most of
+the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom
+to distribute copies of free software (and charge for this service if you wish), that
+you receive source code or can get it if you want it, that you can change the
+software or use pieces of it in new free programs; and that you know you can do
+these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny
+you these rights or to ask you to surrender the rights. These restrictions
+translate to certain responsibilities for you if you distribute copies of the
+software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a
+fee, you must give the recipients all the rights that you have. You must make
+sure that they, too, receive or can get the source code. And you must show
+them these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer
+you this license which gives you legal permission to copy, distribute and/or
+modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced by
+others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish
+to avoid the danger that redistributors of a free program will individually obtain
+patent licenses, in effect making the program proprietary. To prevent this, we
+have made it clear that any patent must be licensed for everyone's free use or
+not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+GNU GENERAL PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
+MODIFICATION
+
+0. This License applies to any program or other work which contains a notice
+placed by the copyright holder saying it may be distributed under the terms of
+this General Public License. The "Program", below, refers to any such program
+or work, and a "work based on the Program" means either the Program or any
+derivative work under copyright law: that is to say, a work containing the
+Program or a portion of it, either verbatim or with modifications and/or translated
+into another language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered by
+this License; they are outside its scope. The act of running the Program is not
+restricted, and the output from the Program is covered only if its contents
+constitute a work based on the Program (independent of having been made by
+running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute verbatim copies of the Program's source code as
+you receive it, in any medium, provided that you conspicuously and appropriately
+publish on each copy an appropriate copyright notice and disclaimer of warranty;
+keep intact all the notices that refer to this License and to the absence of any
+warranty; and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may at
+your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus
+forming a work based on the Program, and copy and distribute such
+modifications or work under the terms of Section 1 above, provided that you also
+meet all of these conditions:
+
+a) You must cause the modified files to carry prominent notices stating that you
+changed the files and the date of any change.
+
+b) You must cause any work that you distribute or publish, that in whole or in
+part contains or is derived from the Program or any part thereof, to be licensed
+as a whole at no charge to all third parties under the terms of this License.
+
+c) If the modified program normally reads commands interactively when run, you
+must cause it, when started running for such interactive use in the most ordinary
+way, to print or display an announcement including an appropriate copyright
+notice and a notice that there is no warranty (or else, saying that you provide a
+warranty) and that users may redistribute the program under these conditions,
+and telling the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an announcement,
+your work based on the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable
+sections of that work are not derived from the Program, and can be reasonably
+considered independent and separate works in themselves, then this License,
+and its terms, do not apply to those sections when you distribute them as
+separate works. But when you distribute the same sections as part of a whole
+which is a work based on the Program, the distribution of the whole must be on
+the terms of this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your rights to
+work written entirely by you; rather, the intent is to exercise the right to control
+the distribution of derivative or collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program with the
+Program (or with a work based on the Program) on a volume of a storage or
+distribution medium does not bring the other work under the scope of this
+License.
+
+3. You may copy and distribute the Program (or a work based on it, under
+Section 2) in object code or executable form under the terms of Sections 1 and 2
+above provided that you also do one of the following:
+
+a) Accompany it with the complete corresponding machine-readable source
+code, which must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange; or,
+
+b) Accompany it with a written offer, valid for at least three years, to give any
+third party, for a charge no more than your cost of physically performing source
+distribution, a complete machine-readable copy of the corresponding source
+code, to be distributed under the terms of Sections 1 and 2 above on a medium
+customarily used for software interchange; or,
+
+c) Accompany it with the information you received as to the offer to distribute
+corresponding source code. (This alternative is allowed only for noncommercial
+distribution and only if you received the program in object code or executable
+form with such an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for making
+modifications to it. For an executable work, complete source code means all the
+source code for all modules it contains, plus any associated interface definition
+files, plus the scripts used to control compilation and installation of the
+executable. However, as a special exception, the source code distributed need
+not include anything that is normally distributed (in either source or binary form)
+with the major components (compiler, kernel, and so on) of the operating system
+on which the executable runs, unless that component itself accompanies the
+executable.
+
+If distribution of executable or object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the source
+code from the same place counts as distribution of the source code, even though
+third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as
+expressly provided under this License. Any attempt otherwise to copy, modify,
+sublicense or distribute the Program is void, and will automatically terminate
+your rights under this License. However, parties who have received copies, or
+rights, from you under this License will not have their licenses terminated so long
+as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it.
+However, nothing else grants you permission to modify or distribute the Program
+or its derivative works. These actions are prohibited by law if you do not accept
+this License. Therefore, by modifying or distributing the Program (or any work
+based on the Program), you indicate your acceptance of this License to do so,
+and all its terms and conditions for copying, distributing or modifying the
+Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program),
+the recipient automatically receives a license from the original licensor to copy,
+distribute or modify the Program subject to these terms and conditions. You
+may not impose any further restrictions on the recipients' exercise of the rights
+granted herein. You are not responsible for enforcing compliance by third parties
+to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent infringement
+or for any other reason (not limited to patent issues), conditions are imposed on
+you (whether by court order, agreement or otherwise) that contradict the
+conditions of this License, they do not excuse you from the conditions of this
+License. If you cannot distribute so as to satisfy simultaneously your obligations
+under this License and any other pertinent obligations, then as a consequence
+you may not distribute the Program at all. For example, if a patent license would
+not permit royalty-free redistribution of the Program by all those who receive
+copies directly or indirectly through you, then the only way you could satisfy
+both it and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under any particular
+circumstance, the balance of the section is intended to apply and the section as
+a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or other
+property right claims or to contest validity of any such claims; this section has
+the sole purpose of protecting the integrity of the free software distribution
+system, which is implemented by public license practices. Many people have
+made generous contributions to the wide range of software distributed through
+that system in reliance on consistent application of that system; it is up to the
+author/donor to decide if he or she is willing to distribute software through any
+other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be a
+consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain countries
+either by patents or by copyrighted interfaces, the original copyright holder who
+places the Program under this License may add an explicit geographical
+distribution limitation excluding those countries, so that distribution is permitted
+only in or among countries not thus excluded. In such case, this License
+incorporates the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the
+General Public License from time to time. Such new versions will be similar in
+spirit to the present version, but may differ in detail to address new problems or
+concerns.
+
+Each version is given a distinguishing version number. If the Program specifies a
+version number of this License which applies to it and "any later version", you
+have the option of following the terms and conditions either of that version or of
+any later version published by the Free Software Foundation. If the Program does
+not specify a version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs
+whose distribution conditions are different, write to the author to ask for
+permission. For software which is copyrighted by the Free Software Foundation,
+write to the Free Software Foundation; we sometimes make exceptions for this.
+Our decision will be guided by the two goals of preserving the free status of all
+derivatives of our free software and of promoting the sharing and reuse of
+software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS
+NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
+COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
+"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
+PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
+YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+12. 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 PROGRAM AS
+PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
+(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 PROGRAM TO OPERATE WITH ANY
+OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS
+BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+
+---------------------------------------------------------------------------
+
+The Artistic License
+
+Preamble
+
+The intent of this document is to state the conditions under which a Package
+may be copied, such that the Copyright Holder maintains some semblance of
+artistic control over the development of the package, while giving the users of the
+package the right to use and distribute the Package in a more-or-less customary
+fashion, plus the right to make reasonable modifications.
+
+Definitions:
+
+- "Package" refers to the collection of files distributed by the Copyright
+ Holder, and derivatives of that collection of files created through textual
+ modification.
+- "Standard Version" refers to such a Package if it has not been modified,
+ or has been modified in accordance with the wishes of the Copyright
+ Holder.
+- "Copyright Holder" is whoever is named in the copyright or copyrights for
+ the package.
+- "You" is you, if you're thinking about copying or distributing this Package.
+- "Reasonable copying fee" is whatever you can justify on the basis of
+ media cost, duplication charges, time of people involved, and so on. (You
+ will not be required to justify it to the Copyright Holder, but only to the
+ computing community at large as a market that must bear the fee.)
+- "Freely Available" means that no fee is charged for the item itself, though
+ there may be fees involved in handling the item. It also means that
+ recipients of the item may redistribute it under the same conditions they
+ received it.
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you duplicate
+all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications derived from
+the Public Domain or from the Copyright Holder. A Package modified in such a
+way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided
+that you insert a prominent notice in each changed file stating how and when
+you changed that file, and provided that you do at least ONE of the following:
+
+ a) place your modifications in the Public Domain or otherwise
+ make them Freely Available, such as by posting said modifications
+ to Usenet or an equivalent medium, or placing the modifications on
+ a major archive site such as ftp.uu.net, or by allowing the
+ Copyright Holder to include your modifications in the Standard
+ Version of the Package.
+
+ b) use the modified Package only within your corporation or
+ organization.
+
+ c) rename any non-standard executables so the names do not
+ conflict with standard executables, which must also be provided,
+ and provide a separate manual page for each non-standard
+ executable that clearly documents how it differs from the Standard
+ Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or executable
+form, provided that you do at least ONE of the following:
+
+ a) distribute a Standard Version of the executables and library
+ files, together with instructions (in the manual page or equivalent)
+ on where to get the Standard Version.
+
+ b) accompany the distribution with the machine-readable source of
+ the Package with your modifications.
+
+ c) accompany any non-standard executables with their
+ corresponding Standard Version executables, giving the
+ non-standard executables non-standard names, and clearly
+ documenting the differences in manual pages (or equivalent),
+ together with instructions on where to get the Standard Version.
+
+ d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this Package.
+You may charge any fee you choose for support of this Package. You may not
+charge a fee for this Package itself. However, you may distribute this Package in
+aggregate with other (possibly commercial) programs as part of a larger
+(possibly commercial) software distribution provided that you do not advertise
+this Package as a product of your own.
+
+6. The scripts and library files supplied as input to or produced as output from
+the programs of this Package do not automatically fall under the copyright of this
+Package, but belong to whomever generated them, and may be sold
+commercially, and may be aggregated with this Package.
+
+7. C or perl subroutines supplied by you and linked into this Package shall not
+be considered part of this Package.
+
+8. Aggregation of this Package with a commercial distribution is always permitted
+provided that the use of this Package is embedded; that is, when no overt attempt
+is made to make this Package's interfaces visible to the end user of the
+commercial distribution. Such use shall not be construed as a distribution of
+this Package.
+
+9. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.
+
+The End
+
+
View
7 MANIFEST
@@ -0,0 +1,7 @@
+MANIFEST
+LICENSE
+README
+Todo
+Changes
+lib/Business/Hours.pm
+Makefile.PL
View
11 Makefile.PL
@@ -0,0 +1,11 @@
+use ExtUtils::MakeMaker;
+# See lib/ExtUtils/MakeMaker.pm for details of how to influence
+# the contents of the Makefile that is written.
+WriteMakefile(
+ NAME => 'Business::Hours',
+ VERSION_FROM => 'lib/Business/Hours.pm', # finds $VERSION
+ AUTHOR => 'Jesse Vincent (jesse@cpan.org)',
+ PREREQ_PM => { Test::Inline => 0,
+ Set::IntSpan => 0},
+ ABSTRACT => '',
+);
View
79 README
@@ -0,0 +1,79 @@
+NAME
+ Business::Hours -
+
+SYNOPSIS
+ use Business::Hours;
+ my $hours = Business::Hours->new();
+ # Get a Set::IntSpan of all the business hours in the next week.
+ # use the default business hours of 9am to 6pm localtime.
+ $hours->business_hours_in_timespan(Start => time(), End => time()+(86400*7));
+
+DESCRIPTION
+ This module is a simple tool for calculating business hours in a time
+ period. Over time, additional functionality will be added to make it
+ easy to calculate the number of business hours between arbitrary dates.
+
+USAGE
+BUGS
+ Yes
+
+SUPPORT
+ Send email to bug-business-hours@rt.cpan.org
+
+AUTHOR
+ Jesse Vincent
+ Best Practical Solutions, LLC
+ jesse@cpan.org
+ http://www.bestpractical.com
+
+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.
+
+SEE ALSO
+ perl(1).
+
+ sample_function
+ Usage : How to use this function/method
+ Purpose : What it does
+ Returns : What it returns
+ Argument : What it wants to know
+ Throws : Exceptions and other anomolies
+ Comments : This is a sample subroutine header.
+ : It is polite to include more pod and fewer comments.
+
+ See Also :
+
+ business_hours
+ Set the business hours for this Business::Hours object. Takes a hash of
+ the form :
+
+ { 0 => { Name => 'Sunday', Start => 'HH::MM', End => 'HH::MM'},
+
+ 1 => { Name => 'Monday',
+ Start => 'HH::MM',
+ End => 'HH::MM'},
+ ....
+
+ 6 => { Name => 'Saturday',
+ Start => 'HH::MM',
+ End => 'HH::MM'},
+ };
+
+ Start and end times are of the form HH:MM. Valid times are
+ from 00:00 to 23:59. If your hours are from 9am to 6pm, use
+ Start => '9:00', End => '18:00'. A given day MUST have a start
+ and end time OR may declare both Start and End to be undef, if
+ there are no valid hours on that day.
+
+ for_timespan
+ Takes a paramhash with the following parameters
+
+ Start => The start of the period in question in seconds since the epoch
+ End => The end of the period in question in seconds since the epoch
+
+ Returns a Set::IntSpan of business hours for this period of time.
+
View
3 Todo
@@ -0,0 +1,3 @@
+Write tests
+Write documentation
+Write code
View
316 lib/Business/Hours.pm
@@ -0,0 +1,316 @@
+package Business::Hours;
+use strict;
+require 5.006;
+use Set::IntSpan;
+
+
+use Time::Local qw/timelocal_nocheck/;
+
+BEGIN {
+ use Exporter ();
+ use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+ $VERSION = 0.01;
+ @ISA = qw (Exporter);
+ #Give a hoot don't pollute, do not export more than needed by default
+ @EXPORT = qw ();
+ @EXPORT_OK = qw ();
+ %EXPORT_TAGS = ();
+}
+
+
+########################################### main pod documentation begin ##
+# Below is the stub of documentation for your module. You better edit it!
+
+
+=head1 NAME
+
+Business::Hours -
+
+=head1 SYNOPSIS
+
+ use Business::Hours;
+ my $hours = Business::Hours->new();
+ # Get a Set::IntSpan of all the business hours in the next week.
+ # use the default business hours of 9am to 6pm localtime.
+ $hours->business_hours_in_timespan(Start => time(), End => time()+(86400*7));
+
+=head1 DESCRIPTION
+
+This module is a simple tool for calculating business hours in a time period.
+Over time, additional functionality will be added to make it easy to calculate the number of
+business hours between arbitrary dates.
+
+
+=head1 USAGE
+
+
+
+=head1 BUGS
+
+Yes
+
+=head1 SUPPORT
+
+Send email to bug-business-hours@rt.cpan.org
+
+
+=head1 AUTHOR
+
+ Jesse Vincent
+ Best Practical Solutions, LLC
+ jesse@cpan.org
+ http://www.bestpractical.com
+
+=head1 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.
+
+
+=head1 SEE ALSO
+
+perl(1).
+
+=cut
+
+############################################# main pod documentation end ##
+
+
+# Default business hours are weekdays from 9 am to 6pm
+our $BUSINESS_HOURS = ({
+ 0 => { Name => 'Sunday',
+ Start => undef,
+ End => undef, },
+ 1 => { Name => 'Monday',
+ Start => '9:00',
+ End => '18:00', },
+ 2 => { Name => 'Tuesday',
+ Start => '9:00',
+ End => '18:00', },
+ 3 => { Name => 'Wednesday',
+ Start => '9:00',
+ End => '18:00', },
+ 4 => { Name => 'Thursday',
+ Start => '9:00',
+ End => '18:00', },
+ 5 => { Name => 'Friday',
+ Start => '9:00',
+ End => '18:00', },
+ 6 => { Name => 'Saturday',
+ Start => undef,
+ End => undef, }
+ });
+
+
+
+################################################ subroutine header begin ##
+
+=head2 sample_function
+
+ Usage : How to use this function/method
+ Purpose : What it does
+ Returns : What it returns
+ Argument : What it wants to know
+ Throws : Exceptions and other anomolies
+ Comments : This is a sample subroutine header.
+ : It is polite to include more pod and fewer comments.
+
+See Also :
+
+=cut
+
+################################################## subroutine header end ##
+
+
+sub new {
+ my $class = shift;
+
+ my $self = bless ({}, ref ($class) || $class);
+
+ return ($self);
+}
+
+=head2 business_hours
+
+Set the business hours for this Business::Hours object.
+Takes a hash of the form :
+
+{
+ 0 => { Name => 'Sunday',
+ Start => 'HH::MM',
+ End => 'HH::MM'},
+
+ 1 => { Name => 'Monday',
+ Start => 'HH::MM',
+ End => 'HH::MM'},
+ ....
+
+ 6 => { Name => 'Saturday',
+ Start => 'HH::MM',
+ End => 'HH::MM'},
+ };
+
+ Start and end times are of the form HH:MM. Valid times are
+ from 00:00 to 23:59. If your hours are from 9am to 6pm, use
+ Start => '9:00', End => '18:00'. A given day MUST have a start
+ and end time OR may declare both Start and End to be undef, if
+ there are no valid hours on that day.
+
+=cut
+
+sub business_hours {
+ my $self = shift;
+ %{$self->{'business_hours'}} = (@_);
+
+}
+
+
+
+=head2 for_timespan
+
+Takes a paramhash with the following parameters
+
+ Start => The start of the period in question in seconds since the epoch
+ End => The end of the period in question in seconds since the epoch
+
+Returns a Set::IntSpan of business hours for this period of time.
+
+
+=begin testing
+
+use Business::Hours;
+my $hours = Business::Hours->new();
+my $hours_span = $hours->for_timespan(Start => time(), End => (time() + (86400 * 14)));
+
+
+=end testing
+
+=cut
+
+
+sub for_timespan {
+ my $self = shift;
+ my %args = ( Start => undef,
+ End => undef,
+ @_ );
+ my $bizdays;
+ if ( $self->{'business_hours'} ) {
+ $bizdays = $self->{'business_hours'};
+ }
+ else {
+ $bizdays = $BUSINESS_HOURS;
+ }
+
+ # Split the Start and End times into hour/minute specifications
+ foreach my $day ( keys %$bizdays ) {
+ my $day_href = $bizdays->{$day};
+ foreach my $which qw(Start End) {
+ if ( $day_href->{$which}
+ && $day_href->{$which} =~ /^(\d+)\D(\d+)$/ ) {
+ $day_href->{ $which . 'Hour' } = $1;
+ $day_href->{ $which . 'Minute' } = $2;
+ }
+ }
+ }
+
+ # now that we know what the business hours are for each day in a week,
+ # we need to find all the business hours in the period in question.
+
+ # Create an intspan of the period in total.
+ my $business_period =
+ Set::IntSpan->new( $args{'Start'} . "-" . $args{'End'} );
+
+ # jump back to the first day (Sunday) of the last week before the period
+ # began.
+ my @start = localtime( $args{'Start'} );
+ my $month = $start[4];
+ my $year = $start[5];
+ my $first_sunday = $start[3] - $start[6];
+
+ # period_start is time_t at midnight local time on the first sunday
+ my $period_start =
+ timelocal_nocheck( 0, 0, 0, $first_sunday, $month, $year );
+
+
+ # for each week until the end of the week in seconds since the epoch
+ # is outside the business period in question
+ my $week_start = $period_start;
+
+ # @run_list is a run list of the period's business hours
+ # its form is (<int>-<int2>,<int3>-<int4>)
+ # For documentation about its format, have a look at Set::IntSpan.
+ # (This is fed into Set::IntSpan to use to compute our actual run.
+ my @run_list;
+
+ while ( $week_start <= $args{'End'} ) {
+
+ my @this_week_start = localtime($week_start);
+
+ # foreach day in the week, find that day's business hours in
+ # seconds since the epoch.
+ for ( my $dow=0; $dow <= 6; $dow++ ) {
+
+ my $day_hours = $bizdays->{$dow};
+ if ( $day_hours->{'Start'} && $day_hours->{'End'} ) {
+
+ # add the business seconds in that week to the runlist we'll use to
+ # figure out business hours
+ # (Be careful to use timelocal to convert times in the week into actual
+ # seconds, so we don't lose at DST transition)
+ my $day_bizhours_start = timelocal_nocheck(
+ 0,
+ $day_hours->{'StartMinute'},
+ $day_hours->{'StartHour'},
+ ( $this_week_start[3] + $dow ),
+ $this_week_start[4],
+ $this_week_start[5] );
+ my $day_bizhours_end = timelocal_nocheck(0,
+ $day_hours->{'EndMinute'},
+ $day_hours->{'EndHour'},
+ ( $this_week_start[3] + $dow ),
+ $this_week_start[4],
+ $this_week_start[5] );
+
+ push (@run_list , "$day_bizhours_start-$day_bizhours_end");
+
+ }
+
+
+ }
+
+
+ # now that we're done with this week, calculate the start of the next week
+ # the next week starts at midnight on the sunday following the previous
+ # sunday
+ $week_start = timelocal_nocheck( 0, 0, 0, ( $this_week_start[3] + 7 ),
+ $this_week_start[4], $this_week_start[5] );
+
+ }
+
+ my $business_hours = Set::IntSpan->new(join(',',@run_list));
+ my $business_hours_in_period = $business_hours->intersect($business_period);
+
+
+ # find the intersection of the business period intspan and the business
+ # hours intspan. (Because we want to trim any business hours that fall
+ # outside the business period)
+
+ # TODO: Remove any holidays from the business hours
+
+ # TODO: Add any special times to the business hours
+
+ # Return the intspan of business hours.
+
+ return ($business_hours_in_period);
+
+}
+
+
+
+
+1; #this line is important and will help the module return a true value
+__END__
+

0 comments on commit 7fc9058

Please sign in to comment.
Something went wrong with that request. Please try again.