Class flDate

flDate Class

Class to provide date related functions.

Package: fusionLib
Copyright: Copyright (c) 2012 - 2013 fusionLib. All rights reserved.
Located at system/libs/Date/flDate.php

Methods summary

`public`	# `__construct( string $date = null, string $tz = 'UTC' )` Construct the date object. Construct the date object. If the timezone is specified in $date then it will be used for setting the date then the value of $tz applied, otherwise the value in $date is assumed to be in $tz timezone. Parameters `$date` The date and time to initialise the object with, yyyy-mm-dd hh:mm:ss, @12345 to set a timestamp or null for current date and time. `$tz` The timezone for $date.
`public flDate`	# `setTimezone( string $tz )` Set the timezone. Set the timezone. Parameters `$tz` The timezone to use. Returns `flDate` This object.
`public flDate`	# `setTime( integer $hour, integer $minute, integer $second = 0 )` Set the time. Set the time. Parameters `$hour` The hour (0 - 23) `$minute` The minute (0 - 59) `$second` The seconds (0 - 59) Returns `flDate` This object.
`public flDate`	# `setDate( integer $year, integer $month, integer $day )` Set the date. Set the date. Parameters `$year` The year. `$month` The month (1 - 12) `$day` The day of the month (1 - 31) Returns `flDate` This object.
`public flDate`	# `setDefaultFormat( string $fmt )` Set the default format string to use. Set the default format string to use. Parameters `$fmt` The default format string to use in toString. Returns `flDate` This object.
`protected boolean`	# `isLeapYear( integer $year )` Test if a year is a leap year. Test if a year is a leap year. Parameters `$year` The year to test. Returns boolean true if leap year (366 days) of false if not (365 days).
`public float`	# `getTimestamp( )` Calculate a timestamp since 00:00:00 UTC on 1 January 1970. Calculate a timestamp since 00:00:00 UTC on 1 January 1970. Returns float The timestamp.
`public flDate`	# `setTimestamp( float $time )` Set the object to the given timestamp. Set the object to the given timestamp. Parameters `$time` The timestamp since 00:00:00 UTC on 1 January 1970. Returns `flDate` This object.
`public array`	# `timeSpan( flDate $since )` Time between the current value and and earlier value. Time between the current value and and earlier value. Parameters `$since` The date object to return how long ago it was. Returns array offset, units where units one of years, months, days, hours, minutes, seconds. Throws `flDateException`
`public string`	# `toString( string $fmt = null )` Format a date into a string. Date codes are proceeded with % in the same way as MySQL DATE_FORMAT. Format a date into a string. Date codes are proceeded with % in the same way as MySQL DATE_FORMAT. Parameters `$fmt` The format string for the date or null to use the default. Returns string The formatted date.
`public string`	# `__toString( )` Return the date as a string. Return the date as a string. Returns string The date as a string.
`public`	# `__clone( )` Clone internal objects. Clone internal objects.
`public integer`	# `compare( flDate $with )` Compares this date object with the passed date and time object. Compares this date object with the passed date and time object. Parameters `$with` The object to compare with this. Returns integer -1 if this is < $with, 0 if they are equal, 1 if this is > $with

Constants summary

`string`	`ATOM` Standard date formats. Standard date formats.	# `'%Y-%m-%dT%H:%i:%s%P'`
`string`	`COOKIE`	# `'%l, %d-%M-%y %H:%i:%s %T'`
`string`	`ISO8601`	# `'%Y-%m-%dT%H:%i:%s%O'`
`string`	`RFC822`	# `'%D, %d %M %y %H:%i:%s %O'`
`string`	`RFC850`	# `'%l, %d-%M-%y %H:%i:%s %T'`
`string`	`RFC1036`	# `'%D, %d %M %y %H:%i:%s %O'`
`string`	`RFC1123`	# `'%D, %d %M %Y %H:%i:%s %O'`
`string`	`RFC2822`	# `'%D, %d %M %Y %H:%i:%s %O'`
`string`	`RFC3339`	# `'%Y-%m-%dT%H:%i:%s%P'`
`string`	`RSS`	# `'%D, %d %M %Y %H:%i:%s %O'`
`string`	`W3C`	# `'%Y-%m-%dT%H:%i:%s%P'`
`string`	`TIME12`	# `'%g:%i:%s %A'`
`string`	`TIME24`	# `'%H:%i:%s'`
`string`	`TIME12SHORT`	# `'%g:%i %A'`
`string`	`TIME24SHORT`	# `'%H:%i'`
`string`	`DATE`	# `'%Y-%m-%d'`
`string`	`DATE2`	# `'%Y-%M-%d'`
`string`	`DATETIME`	# `'%Y-%m-%d %H:%i:%s'`
`string`	`DATETIMESHORT`	# `'%Y-%m-%d %H:%i'`

Properties summary

`protected DateTime`	`$value` The time value. The time value.	#
`protected string`	`$defaultFmt` The default format to use for strings. The default format to use for strings.	# `flDate::DATETIME`