Docs For Class Date

Date_Span (Constructor) [line 173]

Date_Span Date_Span(
[mixed
$time = 0], [mixed
$format = null])

Constructor

Creates the time span object calling the set() method.

See: Date_Span::set()
Access: public

Parameters:

mixed	`$time`	—	time span expression
mixed	`$format`	—	format string to set it from a string or the second date set it from a date diff

[ Top ]

add [line 858]

void add(
object
$time)

Adds a time span

Access: public

Parameters:

object $time — time span to add

[ Top ]

compare [line 991]

int compare(
object
$time1, object
$time2)

Compares two time spans

Suitable for use in sorting functions.

Return: 0 if the time spans are equal, -1 if time1 is lower than time2, 1 if time1 is greater than time2
Access: public

Parameters:

object	`$time1`	—	the first time span
object	`$time2`	—	the second time span

[ Top ]

copy [line 606]

bool copy(
object
$time)

Set the time span from another time object

Return: true on success
Access: public

Parameters:

object $time — source time span object

[ Top ]

equal [line 901]

bool equal(
object
$time)

Tells if time span is equal to $time

Return: true if the time spans are equal
Access: public

Parameters:

object $time — time span to compare to

[ Top ]

format [line 668]

string format(
[string
$format = null])

Time span pretty printing (similar to Date::format())

Formats the time span in the given format, similar to strftime() and Date::format().

Formatting options:

%C

Days with time, same as "%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, same as "%I:%M:%S %p"

%R

Time in 24-hour notation, same as "%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, same as "%H:%M:%S"

%%

Literal '%'

Return: the time span in specified format
Access: public

Parameters:

string $format — the format string for returned time span

[ Top ]

getDefaultFormat [line 1084]

mixed getDefaultFormat(
)

Get the default format

Return: default format
Access: public

[ Top ]

getDefaultInputFormat [line 1048]

mixed getDefaultInputFormat(
)

Get the default input format

Return: default input format
Access: public

[ Top ]

greater [line 952]

bool greater(
object
$time)

Tells if this time span is greater than $time

Return: true if this time span is greater than $time
Access: public

Parameters:

object $time — time span to compare to

[ Top ]

greaterEqual [line 918]

bool greaterEqual(
object
$time)

Tells if this time span is greater or equal than $time

Return: true if this time span is greater or equal than $time
Access: public

Parameters:

object $time — time span to compare to

[ Top ]

isEmpty [line 1012]

bool isEmpty(
)

Tells if the time span is empty (zero length)

Return: true if empty
Access: public

[ Top ]

lower [line 969]

bool lower(
object
$time)

Tells if this time span is lower than $time

Return: true if this time span is lower than $time
Access: public

Parameters:

object $time — time span to compare to

[ Top ]

lowerEqual [line 935]

bool lowerEqual(
object
$time)

Tells if this time span is lower or equal than $time

Return: true if this time span is lower or equal than $time
Access: public

Parameters:

object $time — time span to compare to

[ Top ]

set [line 197]

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.

Return: true on success
See: setFromObject(), Date_Span::setFromArray(), Date_Span::setFromString(), Date_Span::setFromSeconds(), Date_Span::setFromDateDiff()
Access: public

Parameters:

mixed	`$time`	—	time span expression
mixed	`$format`	—	format string to set it from a string or the second date set it from a date diff

[ Top ]

setDefaultFormat [line 1066]

mixed setDefaultFormat(
mixed
$format)

Set the default format

Return: previous default format
Access: public

Parameters:

mixed $format — new default format

[ Top ]

setDefaultInputFormat [line 1030]

mixed setDefaultInputFormat(
mixed
$format)

Set the default input format

Return: previous default input format
Access: public

Parameters:

mixed $format — new default input format

[ Top ]

setFromArray [line 236]

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:

array(23.5, 20, 0)

is interpreted as 23 hours, .5*60 + 20 = 50 minutes and 0 seconds.

Return: true on success
Access: public

Parameters:

array $time — items are counted from right to left. First item is for seconds, second for minutes, third for hours and fourth for days. If there are less items than 4, zero (0) is assumed for the absent values.

[ Top ]

setFromDateDiff [line 569]

bool setFromDateDiff(
object
$date1, object
$date2)

Set the span from the elapsed time between two dates

The time span is unsigned, so the date's order is not important.

Return: true on success
Access: public

Parameters:

object	`$date1`	—	first Date
object	`$date2`	—	second Date

[ Top ]

setFromDays [line 549]

bool setFromDays(
float
$days)

Set the time span from a total number of days

Return: true on success
Access: public

Parameters:

float $days — total number of days

[ Top ]

setFromHours [line 532]

bool setFromHours(
float
$hours)

Set the time span from a total number of hours

Return: true on success
Access: public

Parameters:

float $hours — total number of hours

[ Top ]

setFromMinutes [line 515]

bool setFromMinutes(
float
$minutes)

Set the time span from a total number of minutes

Return: true on success
Access: public

Parameters:

float $minutes — total number of minutes

[ Top ]

setFromSeconds [line 486]

bool setFromSeconds(
int
$seconds)

Set the time span from a total number of seconds

Return: true on success
Access: public

Parameters:

int $seconds — total number of seconds

[ Top ]

setFromString [line 313]

bool setFromString(
string
$time, [string
$format = null])

Set the time span from a string based on an input format

This is some like a mix of format() method and sscanf() PHP function. The error checking and validation of this function is very primitive, so you should be carefull when using it with unknown $time 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 setFromString('10, 20', '%H, %h') your time span would be 20 hours long. Allways remember that this method sets all the values, so if you had a $time span 30 minutes long and you make $time->setFromString('20 hours', '%H hours'), $time span would be 20 hours long (and not 20 hours and 30 minutes). Input format options:

%C

Days with time, same as "%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, same as "%H:%M:%S %p"

%R

Time in 24-hour notation, same as "%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, same as "%H:%M:%S"

%%

Literal '%'

Return: true on success
Access: public

Parameters:

string	`$time`	—	string from where to get the time span information
string	`$format`	—	format string

[ Top ]

subtract [line 879]

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).

Access: public

Parameters:

object $time — time span to subtract

[ Top ]

toDays [line 840]

float toDays(
)

Convert time span to days

Return: time span as a decimal number of days
Access: public

[ Top ]

toHours [line 824]

float toHours(
)

Convert time span to hours

Return: time span as a decimal number of hours
Access: public

[ Top ]

toMinutes [line 808]

float toMinutes(
)

Convert time span to minutes

Return: time span as a decimal number of minutes
Access: public

[ Top ]

toSeconds [line 792]

int toSeconds(
)

Convert time span to seconds

Return: time span as an integer number of seconds
Access: public

[ Top ]

Class: Date_Span

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

Date_Span (Constructor) [line 173]

Parameters:

add [line 858]

Parameters:

compare [line 991]

Parameters:

copy [line 606]

Parameters:

equal [line 901]

Parameters:

format [line 668]

Parameters:

getDefaultFormat [line 1084]

getDefaultInputFormat [line 1048]

greater [line 952]

Parameters:

greaterEqual [line 918]

Parameters:

isEmpty [line 1012]

lower [line 969]

Parameters:

lowerEqual [line 935]

Parameters:

set [line 197]

Parameters:

setDefaultFormat [line 1066]

Parameters:

setDefaultInputFormat [line 1030]

Parameters:

setFromArray [line 236]

Parameters:

setFromDateDiff [line 569]

Parameters:

setFromDays [line 549]

Parameters:

setFromHours [line 532]

Parameters:

setFromMinutes [line 515]

Parameters:

setFromSeconds [line 486]

Parameters:

setFromString [line 313]

Parameters:

subtract [line 879]

Parameters:

toDays [line 840]

toHours [line 824]

toMinutes [line 808]

toSeconds [line 792]