FRAMES NO FRAMES
SUMMARY: FIELD METHOD	DETAIL: FIELD METHOD

default

Class DateTime

default.DateTime

class DateTime

Represents a date time value.

Works with ISO datetime format like "YYYY-MM-DD HH:mm:ss"

Author:: Manolo Gómez

Version:: 1.0

Field Summary

public var	$day
public var	$month
public var	$year
public var	$hour
public var	$minute
public var	$second
private var	$_timestamp
public var	$weekDay

Method Summary

public void	DateTime Constructor
public void	setTimestamp Uses a timestamp integer to build this object's fields
public void	sync Rebuilds object's internal timestamp.
public void	asTime
public void	asDate
public string	getTime
public string	getDate
public void	getTimestamp
public void	getWeekDay
public void	getDayLight
public void	getLocalWeekDay
public void	daysInMonth
public void	isBefore
public void	isAfter
public void	equals
public void	getDateTime
public void	strftime
public void	gmstrftime
public void	daysDiff
public array	dateDiff Calculates the difference between two DateTime objects.
public int	compare Compares two date time values (t1 and t2).
public void	monthName
public integer	findTimestamp Returns the timestamp contained in $dateObj Can work with DateTime objects, string values and integer timestamps
private void	__call
private void	__dateOperation
public void	add
public void	sub
public void	substract
private void	__toString

Field Detail

day

public var $day

month

public var $month

year

public var $year

hour

public var $hour

minute

public var $minute

second

public var $second

_timestamp

private var $_timestamp

weekDay

public var $weekDay

Method Detail

DateTime()

public void DateTime(mixed date = 'now')

Constructor

Parameters:: date - object, string or timestamp to use as a base for the object

setTimestamp()

public void setTimestamp(integer ts)

Uses a timestamp integer to build this object's fields

Parameters:: ts - timestamp to decode

sync()

public void sync()

Rebuilds object's internal timestamp.

A call to this function is needed when adding or substracting days or minutes to the date

asTime()

public void asTime()

asDate()

public void asDate()

getTime()

public string getTime()

Returns:: Time string

getDate()

public string getDate()

Returns:: Date string in ISO format

getTimestamp()

public void getTimestamp()

getWeekDay()

public void getWeekDay()

getDayLight()

public void getDayLight()

getLocalWeekDay()

public void getLocalWeekDay()

daysInMonth()

public void daysInMonth()

isBefore()

public void isBefore(var $time)

Parameters:: $time

isAfter()

public void isAfter(var $time)

Parameters:: $time

equals()

public void equals(var $time)

Parameters:: $time

getDateTime()

public void getDateTime()

strftime()

public void strftime(var $format)

Parameters:: $format

gmstrftime()

public void gmstrftime(var $format)

Parameters:: $format

daysDiff()

public void daysDiff(var $other)

Parameters:: $other

dateDiff()

public array dateDiff(DateTime other)

Calculates the difference between two DateTime objects.

Returns an associative array containing a timespan expressed in days, hours, minutes and seconds.

Parameters:: other - Object to compare with

Returns:: array with difference information

compare()

public int compare(mixed time1,
                   mixed time2)

Compares two date time values (t1 and t2).

Can work with DateTime objects, string values and integer timestamps Possible return values are: -1: t1 < t2 0: t1 = t2 1: t1 > t2

Parameters:: time1 - First time value; time2 - Second time value

Returns:: Result of the comparison

monthName()

public void monthName(var $value = null)

Parameters:: $value

findTimestamp()

public integer findTimestamp(mixed dateObj)

Returns the timestamp contained in $dateObj Can work with DateTime objects, string values and integer timestamps

Parameters:: dateObj - variable to search

Returns:: timestamp

__call()

private void __call(var $method,
                    var $params)

Parameters:: $method; $params

__dateOperation()

private void __dateOperation(var $op,
                             var $part,
                             var $num)

Parameters:: $op; $part; $num

add()

public void add(var $part,
                var $num = 1)

Parameters:: $part; $num

sub()

public void sub(var $part,
                var $num = 1)

Parameters:: $part; $num

substract()

public void substract(var $part,
                      var $num = 1)

Parameters:: $part; $num

__toString()

private void __toString()

FRAMES NO FRAMES
SUMMARY: FIELD METHOD	DETAIL: FIELD METHOD