changed POD formatting
This commit is contained in:
JT Smith
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -83,26 +83,22 @@ sub dateToEpoch {
|
|||
|
||||
Returns an epoch date with the amount of time added.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970.
|
||||
|
||||
=item years
|
||||
=head3 years
|
||||
|
||||
The number of years to add to the epoch.
|
||||
|
||||
=item months
|
||||
=head3 months
|
||||
|
||||
The number of months to add to the epoch.
|
||||
|
||||
=item days
|
||||
=head3 days
|
||||
|
||||
The number of days to add to the epoch.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub addToDate {
|
||||
|
|
@ -121,26 +117,22 @@ sub addToDate {
|
|||
|
||||
Returns an epoch date with the amount of time added.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970.
|
||||
|
||||
=item hours
|
||||
=head3 hours
|
||||
|
||||
The number of hours to add to the epoch.
|
||||
|
||||
=item minutes
|
||||
=head3 minutes
|
||||
|
||||
The number of minutes to add to the epoch.
|
||||
|
||||
=item seconds
|
||||
=head3 seconds
|
||||
|
||||
The number of seconds to add to the epoch.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub addToTime {
|
||||
|
|
@ -159,14 +151,10 @@ sub addToTime {
|
|||
|
||||
Returns an epoch date.
|
||||
|
||||
=over
|
||||
|
||||
=item date
|
||||
=head3 date
|
||||
|
||||
An array of the format year, month, day, hour, min, sec.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub arrayToEpoch {
|
||||
|
|
@ -188,14 +176,10 @@ sub arrayToEpoch {
|
|||
|
||||
Returns the epoch dates for the start and end of the day.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub dayStartEnd {
|
||||
|
|
@ -212,14 +196,10 @@ sub dayStartEnd {
|
|||
|
||||
Returns a date array in the form of year, month, day, hour, min, sec.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
An epoch date.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub epochToArray {
|
||||
|
|
@ -234,13 +214,11 @@ sub epochToArray {
|
|||
|
||||
Returns a formated date string.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970. Defaults to NOW!
|
||||
|
||||
=item format
|
||||
=head3 format
|
||||
|
||||
A string representing the output format for the date. Defaults to '%z %Z'. You can use the following to format your date string:
|
||||
|
||||
|
|
@ -268,8 +246,6 @@ A string representing the output format for the date. Defaults to '%z %Z'. You c
|
|||
%z = The current user's date format preference.
|
||||
%Z = The current user's time format preference.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub epochToHuman {
|
||||
|
|
@ -359,18 +335,14 @@ sub epochToHuman {
|
|||
|
||||
Returns a set date (used by WebGUI::HTMLForm->date) in the format of YYYY-MM-DD.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970.
|
||||
|
||||
=item withTime
|
||||
=head3 withTime
|
||||
|
||||
A boolean indicating that the time should be added to the output, thust turning the format into YYYY-MM-DD HH:MM:SS.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub epochToSet {
|
||||
|
|
@ -386,14 +358,10 @@ sub epochToSet {
|
|||
|
||||
Returns a string containing the calendar month name in the language of the current user.
|
||||
|
||||
=over
|
||||
|
||||
=item month
|
||||
=head3 month
|
||||
|
||||
An integer ranging from 1-12 representing the month.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getMonthName {
|
||||
|
|
@ -430,14 +398,10 @@ sub getMonthName {
|
|||
|
||||
Returns a string containing the weekday name in the language of the current user.
|
||||
|
||||
=over
|
||||
|
||||
=item day
|
||||
=head3 day
|
||||
|
||||
An integer ranging from 1-7 representing the day of the week (Sunday is 1 and Saturday is 7).
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getDayName {
|
||||
|
|
@ -465,14 +429,10 @@ sub getDayName {
|
|||
|
||||
Returns the total number of days in the month.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
An epoch date.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getDaysInMonth {
|
||||
|
|
@ -488,18 +448,14 @@ sub getDaysInMonth {
|
|||
|
||||
Returns the number of days between two epoch dates.
|
||||
|
||||
=over
|
||||
|
||||
=item start
|
||||
=head3 start
|
||||
|
||||
An epoch date.
|
||||
|
||||
=item end
|
||||
=head3 end
|
||||
|
||||
An epoch date.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getDaysInInterval {
|
||||
|
|
@ -518,14 +474,10 @@ sub getDaysInInterval {
|
|||
|
||||
Returns the position (1 - 7) of the first day in the month.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
An epoch date.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getFirstDayInMonthPosition {
|
||||
|
|
@ -548,14 +500,10 @@ sub getFirstDayInMonthPosition {
|
|||
|
||||
Calculates the number of seconds into the day of an epoch date the epoch datestamp is.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970 00:00:00.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub getSecondsFromEpoch {
|
||||
|
|
@ -570,14 +518,10 @@ sub getSecondsFromEpoch {
|
|||
|
||||
Returns an epoch date derived from the human date.
|
||||
|
||||
=over
|
||||
|
||||
=item date
|
||||
=head3 date
|
||||
|
||||
The human date string. YYYY-MM-DD HH:MM:SS
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub humanToEpoch {
|
||||
|
|
@ -601,18 +545,14 @@ sub humanToEpoch {
|
|||
|
||||
Returns the number of seconds derived from the interval.
|
||||
|
||||
=over
|
||||
|
||||
=item interval
|
||||
=head3 interval
|
||||
|
||||
An integer which represents the amount of time for the interval.
|
||||
|
||||
=item units
|
||||
=head3 units
|
||||
|
||||
A string which represents the units of the interval. The string must be 'years', 'months', 'weeks', 'days', 'hours', 'minutes', or 'seconds'.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub intervalToSeconds {
|
||||
|
|
@ -639,14 +579,10 @@ sub intervalToSeconds {
|
|||
|
||||
Returns an array of time elements. The elements are: years, months, days, hours, minutes, seconds, day of year, day of week, daylight savings.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970. Defaults to now.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub localtime {
|
||||
|
|
@ -667,18 +603,14 @@ sub localtime {
|
|||
|
||||
Returns the number of months between the start and end dates (inclusive).
|
||||
|
||||
=over
|
||||
|
||||
=item startEpoch
|
||||
=head3 startEpoch
|
||||
|
||||
An epoch datestamp corresponding to the first month.
|
||||
|
||||
=item endEpoch
|
||||
=head3 endEpoch
|
||||
|
||||
An epoch datestamp corresponding to the last month.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub monthCount {
|
||||
|
|
@ -697,14 +629,10 @@ sub monthCount {
|
|||
|
||||
Returns the epoch dates for the start and end of the month.
|
||||
|
||||
=over
|
||||
|
||||
=item epoch
|
||||
=head3 epoch
|
||||
|
||||
The number of seconds since January 1, 1970.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub monthStartEnd {
|
||||
|
|
@ -721,14 +649,10 @@ sub monthStartEnd {
|
|||
|
||||
Returns an interval and units derived the number of seconds.
|
||||
|
||||
=over
|
||||
|
||||
=item seconds
|
||||
=head3 seconds
|
||||
|
||||
The number of seconds in the interval.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub secondsToInterval {
|
||||
|
|
@ -764,14 +688,10 @@ sub secondsToInterval {
|
|||
|
||||
Returns a time string of the format HH::MM::SS on a 24 hour clock. See also timeToSeconds().
|
||||
|
||||
=over
|
||||
|
||||
=item seconds
|
||||
=head3 seconds
|
||||
|
||||
A number of seconds.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub secondsToTime {
|
||||
|
|
@ -791,14 +711,10 @@ sub secondsToTime {
|
|||
|
||||
Returns an epoch date.
|
||||
|
||||
=over
|
||||
|
||||
=item set
|
||||
=head3 set
|
||||
|
||||
A string in the format of YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub setToEpoch {
|
||||
|
|
@ -842,14 +758,10 @@ sub time {
|
|||
|
||||
Returns the seconds since 00:00:00 on a 24 hour clock.
|
||||
|
||||
=over
|
||||
|
||||
=item timeString
|
||||
=head3 timeString
|
||||
|
||||
A string that looks similar to this: 15:05:32
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub timeToSeconds {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue