home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _a649e1d544475e887085d139d3251325 < prev    next >
Text File  |  2000-03-23  |  9KB  |  235 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Time::Period - A Perl module to deal with time periods.</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Time::Period - A Perl module to deal with time periods.</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#period examples">PERIOD EXAMPLES</A></LI>
  28.     </UL>
  29.  
  30.     <LI><A HREF="#version">VERSION</A></LI>
  31.     <LI><A HREF="#history">HISTORY</A></LI>
  32.     <LI><A HREF="#author">AUTHOR</A></LI>
  33.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  34.     <LI><A HREF="#date">DATE</A></LI>
  35.     <LI><A HREF="#source">SOURCE</A></LI>
  36. </UL>
  37. <!-- INDEX END -->
  38.  
  39. <HR>
  40. <P>
  41. <H1><A NAME="name">NAME</A></H1>
  42. <P>Time::Period - A Perl module to deal with time periods.</P>
  43. <P>
  44. <HR>
  45. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  46. <UL>
  47. <LI>Linux</LI>
  48. <LI>Solaris</LI>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <P><CODE>use Time::Period;</CODE></P>
  54. <P><CODE>$result = inPeriod($time, $period);</CODE></P>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P>The <STRONG>inPeriod</STRONG> function determines if a given time falls within a given
  59. period.  <STRONG>inPeriod</STRONG> returns <STRONG>1</STRONG> if the time does fall within the given
  60. period, <STRONG>0</STRONG> if not, and <STRONG>-1</STRONG> if <STRONG>inPeriod</STRONG> detects a malformed time or
  61. period.</P>
  62. <P>The time is specified as per the <A HREF="../../../lib/Pod/perlfunc.html#item_time"><CODE>time()</CODE></A> function, which is assumed to
  63. be the number of non-leap seconds since January 1, 1970.</P>
  64. <P>The period is specified as a string which adheres to the format</P>
  65. <PRE>
  66.         sub-period[, sub-period...]</PRE>
  67. <P>or the string ``none'' or whitespace.  The string ``none'' is not case
  68. sensitive.</P>
  69. <P>If the period is blank, then any time period is assumed because the time
  70. period has not been restricted.  In that case, <STRONG>inPeriod</STRONG> returns 1.  If
  71. the period is ``none'', then no time period applies and <STRONG>inPeriod</STRONG> returns
  72. 0.</P>
  73. <P>A sub-period is of the form</P>
  74. <PRE>
  75.         scale {range [range ...]} [scale {range [range ...]}]</PRE>
  76. <P>Scale must be one of nine different scales (or their equivalent codes):</P>
  77. <PRE>
  78.         Scale  | Scale | Valid Range Values
  79.                | Code  |
  80.         *******|*******|************************************************
  81.         year   |  yr   | n     where n is an integer 0<=n<=99 or n>=1970
  82.         month  |  mo   | 1-12  or  jan, feb, mar, apr, may, jun, jul,
  83.                |       |           aug, sep, oct, nov, dec
  84.         week   |  wk   | 1-6
  85.         yday   |  yd   | 1-365
  86.         mday   |  md   | 1-31
  87.         wday   |  wd   | 1-7   or  su, mo, tu, we, th, fr, sa
  88.         hour   |  hr   | 0-23  or  12am 1am-11am 12noon 12pm 1pm-11pm
  89.         minute |  min  | 0-59
  90.         second |  sec  | 0-59</PRE>
  91. <P>The same scale type may be specified multiple times.  Additional scales
  92. simply extend the range defined by previous scales of the same type.</P>
  93. <P>The range for a given scale must be a valid value in the form of</P>
  94. <PRE>
  95.         v</PRE>
  96. <P>or</P>
  97. <PRE>
  98.         v-v</PRE>
  99. <P>For the range specification v-v, if the second value is larger than
  100. the first value, the range wraps around unless the scale specification
  101. is year.</P>
  102. <P>Year does not wrap because the year is never really reset, it just
  103. increments.  Ignoring that fact has lead to the dreaded year 2000
  104. nightmare.  When the year rolls over from 99 to 00, it has really rolled
  105. over a century, not gone back a century.  <STRONG>inPeriod</STRONG> supports the
  106. dangerous two digit year notation because it is so rampant.  However,
  107. <STRONG>inPeriod</STRONG> converts the two digit notation to four digits by prepending
  108. the first two digits from the current year.  In the case of 99-1972, the
  109. 99 is translated to whatever current century it is (probably 20th), and
  110. then range 99-1972 is treated as 1972-1999.  If it were the 21st century,
  111. then the range would be 1972-2099.</P>
  112. <P>Anyway, if v-v is 9-2 and the scale is month, September, October,
  113. November, December, January, and February are the months that the range
  114. specifies.  If v-v is 2-9, then the valid months are February, March,
  115. April, May, Jun, July, August, and September.  9-2 is the same as Sep-Feb.</P>
  116. <P>v isn't a point in time.  In the context of the hour scale, 9 specifies
  117. the time period from 9:00:00 am to 9:59:59 am.  This is what most people
  118. would call 9-10.  In other words, v is discrete in its time scale.
  119. 9 changes to 10 when 9:59:59 changes to 10:00:00, but it is 9 from
  120. 9:00:00 to 9:59:59.  Just before 9:00:00, v was 8.</P>
  121. <P>Note that whitespace can be anywhere and case is not important.  Note
  122. also that scales must be specified either in long form (year, month,
  123. week, etc.) or in code form (yr, mo, wk, etc.).  Scale forms may be
  124. mixed in a period statement.</P>
  125. <P>Furthermore, when using letters to specify ranges, only the first two
  126. for week days or the first three for months are significant.  January
  127. is a valid specification for jan, and Sunday is a valid specification
  128. for su.  Sun is also valid for su.</P>
  129. <P>
  130. <H2><A NAME="period examples">PERIOD EXAMPLES</A></H2>
  131. <P>To specify a time period from Monday through Friday, 9am to 5pm, use a
  132. period such as</P>
  133. <PRE>
  134.         wd {Mon-Fri} hr {9am-4pm}</PRE>
  135. <P>When specifing a range by using -, it is best to think of - as meaning
  136. through.  It is 9am through 4pm, which is just before 5pm.</P>
  137. <P>To specify a time period from Monday through Friday, 9am to 5pm on
  138. Monday, Wednesday, and Friday, and 9am to 3pm on Tuesday and Thursday,
  139. use a period such as</P>
  140. <PRE>
  141.         wd {Mon Wed Fri} hr {9am-4pm}, wd{Tue Thu} hr {9am-2pm}</PRE>
  142. <P>To specify a time period that extends Mon-Fri 9am-5pm, but alternates
  143. weeks in a month, use a period such as</P>
  144. <PRE>
  145.         wk {1 3 5} wd {Mon Wed Fri} hr {9am-4pm}</PRE>
  146. <P>Or how about a period that specifies winter?</P>
  147. <PRE>
  148.         mo {Nov-Feb}</PRE>
  149. <P>This is equivalent to the previous example:</P>
  150. <PRE>
  151.         mo {Jan-Feb Nov-Dec}</PRE>
  152. <P>As is</P>
  153. <PRE>
  154.         mo {jan feb nov dec}</PRE>
  155. <P>And this is too:</P>
  156. <PRE>
  157.         mo {Jan Feb}, mo {Nov Dec}</PRE>
  158. <P>Wait!  So is this:</P>
  159. <PRE>
  160.         mo {Jan Feb} mo {Nov Dec}</PRE>
  161. <P>To specify a period that describes every other half-hour, use something
  162. like</P>
  163. <PRE>
  164.         minute { 0-29 }</PRE>
  165. <P>To specify the morning, use</P>
  166. <PRE>
  167.         hour { 12am-11am }</PRE>
  168. <P>Remember, 11am is not 11:00:00am, but rather 11:00:00am - 11:59:59am.</P>
  169. <P>Hmmmm, 5 second blocks could be a fun period...</P>
  170. <PRE>
  171.         sec {0-4 10-14 20-24 30-34 40-44 50-54}</PRE>
  172. <P>To specify every first half-hour on alternating week days, and the second
  173. half-hour the rest of the week, use the period</P>
  174. <PRE>
  175.         wd {1 3 5 7} min {0-29}, wd {2 4 6} min {30-59}</PRE>
  176. <P>
  177. <HR>
  178. <H1><A NAME="version">VERSION</A></H1>
  179. <P>1.20</P>
  180. <P>
  181. <HR>
  182. <H1><A NAME="history">HISTORY</A></H1>
  183. <PRE>
  184.         Version 1.20
  185.         ------------
  186.                 - Added the ability to specify no time period.</PRE>
  187. <PRE>
  188.         Version 1.13
  189.         ------------
  190.                 - Cleaned up the error checking code.</PRE>
  191. <PRE>
  192.         Version 1.12
  193.         ------------
  194.                 - Updated email and web space information.</PRE>
  195. <PRE>
  196.         Version 1.11
  197.         ------------
  198.                 - Minor bug fix in 1.10.</PRE>
  199. <PRE>
  200.         Version 1.10
  201.         ------------
  202.                 - Released.</PRE>
  203. <P>
  204. <HR>
  205. <H1><A NAME="author">AUTHOR</A></H1>
  206. <P>Patrick Ryan <<A HREF="mailto:pgryan@geocities.com">pgryan@geocities.com</A>></P>
  207. <P>
  208. <HR>
  209. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  210. <P>Copyright (c) 1997 Patrick Ryan.  All rights reserved.  This Perl module
  211. uses the conditions given by Perl.  This module may only be distributed
  212. and or modified under the conditions given by Perl.</P>
  213. <P>
  214. <HR>
  215. <H1><A NAME="date">DATE</A></H1>
  216. <P>August 26, 1997</P>
  217. <P>
  218. <HR>
  219. <H1><A NAME="source">SOURCE</A></H1>
  220. <P>This distribution can be found at</P>
  221. <PRE>
  222.         <A HREF="http://www.geocities.com/SiliconValley/Lakes/8456/">http://www.geocities.com/SiliconValley/Lakes/8456/</A></PRE>
  223. <P>or</P>
  224. <PRE>
  225.         <A HREF="http://www.perl.com/CPAN/modules/by-module/Time/">http://www.perl.com/CPAN/modules/by-module/Time/</A></PRE>
  226. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  227. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  228. <STRONG><P CLASS=block> Time::Period - A Perl module to deal with time periods.</P></STRONG>
  229. </TD></TR>
  230. </TABLE>
  231.  
  232. </BODY>
  233.  
  234. </HTML>
  235.