Class: Date_Span
Source Location: /Date-1.5.0a4/Date/Span.php
Generic time span handling class for PEAR
Author(s):
Version:
Copyright:
- 1997-2006 Leandro Lucarella, Pierre-Alain Joye
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Method Detail
Date_Span (Constructor) [line 177]
Date_Span Date_Span(
[mixed
$time = 0], [mixed
$format = null])
|
|
Constructor Creates the time span object calling Date_Span::set()
Parameters:
add [line 906]
Adds a time span
Parameters:
compare [line 1050]
int compare(
object
$time1, object
$time2)
|
|
Compares two time spans Suitable for use in sorting functions.
Parameters:
copy [line 644]
Sets the time span from another time object
Parameters:
equal [line 952]
bool equal(
object
$time)
|
|
Tells if time span is equal to $time
Parameters:
format [line 707]
string format(
[string
$format = null])
|
|
Formats time span according to specified code (similar to Date::formatLikeStrftime()) Uses a code based on strftime(). Formatting options: - %C - Days with time, equivalent to '%D, %H:%M:%S'
- %d - Total days as a float number
(2 days, 12 hours = 2.5 days)
- %D - Days as a decimal number
- %e - Total hours as a float number
(1 day, 2 hours, 30 minutes = 26.5 hours)
- %E - Total hours as a decimal number
(1 day, 2 hours, 40 minutes = 26 hours)
- %f - Total minutes as a float number
(2 minutes, 30 seconds = 2.5 minutes)
- %F - Total minutes as a decimal number
(1 hour, 2 minutes, 40 seconds = 62 minutes)
- %g - Total seconds as a decimal number
(2 minutes, 30 seconds = 90 seconds)
- %h - Hours as decimal number (0 to 23)
- %H - Hours as decimal number (00 to 23)
- %i - Hours as decimal number on 12-hour clock
(1 to 12)
- %I - Hours as decimal number on 12-hour clock
(01 to 12)
- %m - Minutes as a decimal number (0 to 59)
- %M - Minutes as a decimal number (00 to 59)
- %n - Newline character (\n)
- %p - Either 'am' or 'pm' depending on the time
- %P - Either 'AM' or 'PM' depending on the time
- %r - Time in am/pm notation, equivalent to '%I:%M:%S %p'
- %R - Time in 24-hour notation, equivalent to '%H:%M'
- %s - Seconds as a decimal number (0 to 59)
- %S - Seconds as a decimal number (00 to 59)
- %t - Tab character (\t)
- %T - Current time equivalent, equivalent to '%H:%M:%S'
- %% - Literal '%'
Parameters:
getDefaultFormat [line 1147]
mixed getDefaultFormat(
)
|
|
Returns the default format
getDefaultInputFormat [line 1109]
mixed getDefaultInputFormat(
)
|
|
Returns the default input format
greater [line 1009]
bool greater(
object
$time)
|
|
Tells if this time span is greater than $time
Parameters:
greaterEqual [line 971]
bool greaterEqual(
object
$time)
|
|
Tells if this time span is greater or equal than $time
Parameters:
isEmpty [line 1071]
Tells if the time span is empty (zero length)
lower [line 1028]
bool lower(
object
$time)
|
|
Tells if this time span is lower than $time
Parameters:
lowerEqual [line 990]
bool lowerEqual(
object
$time)
|
|
Tells if this time span is lower or equal than $time
Parameters:
set [line 202]
bool set(
[mixed
$time = 0], [mixed
$format = null])
|
|
Set the time span to a new value in a 'smart' way Sets the time span depending on the argument types, calling to the appropriate setFromXxx() method.
Parameters:
setDefaultFormat [line 1128]
mixed setDefaultFormat(
mixed
$format)
|
|
Sets the default format
Parameters:
setDefaultInputFormat [line 1090]
mixed setDefaultInputFormat(
mixed
$format)
|
|
Sets the default input format
Parameters:
setFromArray [line 242]
bool setFromArray(
array
$time)
|
|
Set the time span from an array Any value can be a float (but it has no sense in seconds), for example:
is interpreted as 23 hours, 0.5 * 60 + 20 = 50 minutes and 0 seconds.
Parameters:
setFromDateDiff [line 596]
bool setFromDateDiff(
object
$date1, object
$date2)
|
|
Sets the span from the elapsed time between two dates The time span is unsigned, so the date's order is not important.
Parameters:
setFromDays [line 575]
bool setFromDays(
float
$days)
|
|
Sets the time span from a total number of days
Parameters:
setFromHours [line 556]
bool setFromHours(
float
$hours)
|
|
Sets the time span from a total number of hours
Parameters:
setFromMinutes [line 537]
bool setFromMinutes(
float
$minutes)
|
|
Sets the time span from a total number of minutes
Parameters:
setFromSeconds [line 506]
bool setFromSeconds(
int
$seconds)
|
|
Set the time span from a total number of seconds
Parameters:
setFromString [line 331]
bool setFromString(
string
$time, [string
$format = null])
|
|
Sets the time span from a string, based on an input format This is some like a mix of the PHP functions strftime() and sscanf(). The error checking and validation of this function is very primitive, so you should be careful when using it with unknown strings. With this method you are assigning day, hour, minute and second values, and the last values are used. This means that if you use something like:
your time span would be 20 hours long. Always remember that this method sets all the values, so if you had a span object 30 minutes long and you call:
the span object would be 20 hours long (and not 20 hours and 30 minutes). Input format options: - %C - Days with time, equivalent to 'D, %H:%M:%S'
- %d - Total days as a float number
(2 days, 12 hours = 2.5 days)
- %D - Days as a decimal number
- %e - Total hours as a float number
(1 day, 2 hours, 30 minutes = 26.5 hours)
- %f - Total minutes as a float number
(2 minutes, 30 seconds = 2.5 minutes)
- %g - Total seconds as a decimal number
(2 minutes, 30 seconds = 90 seconds)
- %h - Hours as decimal number
- %H - Hours as decimal number limited to 2 digits
- %m - Minutes as a decimal number
- %M - Minutes as a decimal number limited to 2 digits
- %n - Newline character (\n)
- %p - Either 'am' or 'pm' depending on the time. If 'pm'
is detected it adds 12 hours to the resulting time
span (without any checks). This is case
insensitive.
- %r - Time in am/pm notation, equivalent to 'H:%M:%S %p'
- %R - Time in 24-hour notation, equivalent to 'H:%M'
- %s - Seconds as a decimal number
- %S - Seconds as a decimal number limited to 2 digits
- %t - Tab character (\t)
- %T - Current time equivalent, equivalent to 'H:%M:%S'
- %% - Literal '%'
Parameters:
subtract [line 928]
void subtract(
object
$time)
|
|
Subtracts a time span If the time span to subtract is larger than the original, the result is zero (there's no sense in negative time spans).
Parameters:
toDays [line 887]
Converts time span to days
toHours [line 869]
Converts time span to hours
toMinutes [line 851]
Converts time span to minutes
toSeconds [line 833]
Converts time span to seconds
Documentation generated on Mon, 11 Mar 2019 15:55:01 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|