TimeHelper Class Reference

Inheritance diagram for TimeHelper:


Public Member Functions
	convert ($serverTime, $userOffset)
	dayAsSql ($dateString, $fieldName, $userOffset=null)
	daysAsSql ($begin, $end, $fieldName, $userOffset=null)
	format ($format= 'd-m-Y', $date, $invalid=false, $userOffset=null)
	fromString ($dateString, $userOffset=null)
	gmt ($string=null)
	isThisMonth ($dateString, $userOffset=null)
	isThisWeek ($dateString, $userOffset=null)
	isThisYear ($dateString, $userOffset=null)
	isToday ($dateString, $userOffset=null)
	isTomorrow ($dateString, $userOffset=null)
	nice ($dateString=null, $userOffset=null)
	niceShort ($dateString=null, $userOffset=null)
	relativeTime ($dateTime, $options=array())
	serverOffset ()
	timeAgoInWords ($dateTime, $options=array())
	toAtom ($dateString, $userOffset=null)
	toQuarter ($dateString, $range=false)
	toRSS ($dateString, $userOffset=null)
	toUnix ($dateString, $userOffset=null)
	wasWithinLast ($timeInterval, $dateString, $userOffset=null)
	wasYesterday ($dateString, $userOffset=null)

Detailed Description

Definition at line 37 of file time.php.

Member Function Documentation

TimeHelper::convert	(	$	serverTime,
		$	userOffset
	)

Converts given time (in server's time zone) to user's local time, given his/her offset from GMT.

Parameters:

	string	$server_time UNIX timestamp
	int	$user_offset User's offset from GMT (in hours)

Returns:: string UNIX timestamp

Definition at line 45 of file time.php.

References serverOffset().

Referenced by fromString().

TimeHelper::dayAsSql	(	$	dateString,
		$	fieldName,
		$	userOffset = `null`
	)

Returns a partial SQL string to search for all records between two times occurring on the same day.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	string	$fieldName Name of database field to compare with
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Partial SQL string.

Definition at line 151 of file time.php.

References daysAsSql(), fromString(), and Helper::output().

TimeHelper::daysAsSql	(	$	begin,
		$	end,
		$	fieldName,
		$	userOffset = `null`
	)

Returns a partial SQL string to search for all records between two dates.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	string	$end Datetime string or Unix timestamp
	string	$fieldName Name of database field to compare with
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Partial SQL string.

Definition at line 133 of file time.php.

References fromString(), and Helper::output().

Referenced by dayAsSql().

TimeHelper::format	(	$	format = `'d-m-Y'`,
		$	date,
		$	invalid = `false`,
		$	userOffset = `null`
	)

Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.

Parameters:

	string	$dateString Datetime string
	boolean	$invalid flag to ignore results of fromString == false
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Formatted date string

Definition at line 529 of file time.php.

References fromString().

Referenced by timeAgoInWords().

TimeHelper::fromString	(	$	dateString,
		$	userOffset = `null`
	)

Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.

Parameters:

	string	$dateString Datetime string
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Formatted date string

Definition at line 69 of file time.php.

References convert().

Referenced by dayAsSql(), daysAsSql(), format(), gmt(), isThisMonth(), isThisWeek(), isThisYear(), isToday(), isTomorrow(), nice(), niceShort(), timeAgoInWords(), toAtom(), toQuarter(), toRSS(), toUnix(), wasWithinLast(), and wasYesterday().

TimeHelper::gmt ( $ string = null )

Returns gmt, given either a UNIX timestamp or a valid strtotime() date string.

Parameters:

string

$dateString Datetime string

Returns:: string Formatted date string

Definition at line 504 of file time.php.

References fromString().

TimeHelper::isThisMonth	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string is within this month

Parameters:

	string	$dateString
	int	$userOffset User's offset from GMT (in hours)

Returns:: boolean True if datetime string is within current month

Definition at line 183 of file time.php.

References fromString().

TimeHelper::isThisWeek	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string is within this week

Parameters:

	string	$dateString
	int	$userOffset User's offset from GMT (in hours)

Returns:: boolean True if datetime string is within current week

Definition at line 173 of file time.php.

References fromString().

TimeHelper::isThisYear	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string is within current year.

Parameters:

string

$dateString Datetime string or Unix timestamp

Returns:: boolean True if datetime string is within current year

Definition at line 193 of file time.php.

References fromString().

Referenced by niceShort().

TimeHelper::isToday	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string is today.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: boolean True if datetime string is today

Definition at line 163 of file time.php.

References fromString().

Referenced by niceShort().

TimeHelper::isTomorrow	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string is tomorrow.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: boolean True if datetime string was yesterday

Definition at line 215 of file time.php.

References fromString().

TimeHelper::nice	(	$	dateString = `null`,
		$	userOffset = `null`
	)

Returns a nicely formatted date string for given Datetime string.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Formatted date string

Definition at line 87 of file time.php.

References fromString(), and Helper::output().

TimeHelper::niceShort	(	$	dateString = `null`,
		$	userOffset = `null`
	)

Returns a formatted descriptive date string for given datetime string.

If the given date is today, the returned string could be "Today, 16:54". If the given date was yesterday, the returned string could be "Yesterday, 16:54". If $dateString's year is the current year, the returned string does not include mention of the year.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Described, relative date string

Definition at line 109 of file time.php.

References fromString(), isThisYear(), isToday(), Helper::output(), and wasYesterday().

TimeHelper::relativeTime	(	$	dateTime,
		$	options = `array()`
	)

Alias for timeAgoInWords

Parameters:

	mixed	$dateTime Datetime string (strtotime-compatible) or Unix timestamp
	mixed	$options Default format string, if timestamp is used in $dateTime, or an array of options to be passed on to timeAgoInWords().

Returns:: string Relative time string.

See also:: TimeHelper::timeAgoInWords

Definition at line 472 of file time.php.

References timeAgoInWords().

TimeHelper::serverOffset ( )

Returns server's offset from GMT in seconds.

Returns:: int Offset

Definition at line 56 of file time.php.

Referenced by convert().

TimeHelper::timeAgoInWords	(	$	dateTime,
		$	options = `array()`
	)

Returns either a relative date or a formatted date depending on the difference between the current time and given datetime. $datetime should be in a strtotime-parsable format, like MySQL's datetime datatype.

Options: 'format' => a fall back format if the relative time is longer than the duration specified by end 'end' => The end of relative time telling 'userOffset' => Users offset from GMT (in hours)

Relative dates look something like this: 3 weeks, 4 days ago 15 seconds ago Formatted dates look like this: on 02/18/2004

The returned string includes 'ago' or 'on' and assumes you'll properly add a word like 'Posted ' before the function output.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	array	$options Default format if timestamp is used in $dateString

Returns:: string Relative time string.

Definition at line 311 of file time.php.

References format(), fromString(), and Helper::output().

Referenced by relativeTime().

TimeHelper::toAtom	(	$	dateString,
		$	userOffset = `null`
	)

Returns a date formatted for Atom RSS feeds.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Formatted date string

Definition at line 271 of file time.php.

References fromString(), and Helper::output().

TimeHelper::toQuarter	(	$	dateString,
		$	range = `false`
	)

Returns the quart

Parameters:

	string	$dateString
	boolean	$range if true returns a range in Y-m-d format

Returns:: boolean True if datetime string is within current week

Definition at line 225 of file time.php.

References fromString(), and Helper::output().

TimeHelper::toRSS	(	$	dateString,
		$	userOffset = `null`
	)

Formats date for RSS feeds

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: string Formatted date string

Definition at line 283 of file time.php.

References fromString(), and Helper::output().

TimeHelper::toUnix	(	$	dateString,
		$	userOffset = `null`
	)

Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().

Parameters:

	string	$dateString Datetime string to be represented as a Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: integer Unix timestamp

Definition at line 260 of file time.php.

References fromString(), and Helper::output().

TimeHelper::wasWithinLast	(	$	timeInterval,
		$	dateString,
		$	userOffset = `null`
	)

Returns true if specified datetime was within the interval specified, else false.

Parameters:

	mixed	$timeInterval the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
	int	$userOffset User's offset from GMT (in hours)
	mixed	$dateString the datestring or unix timestamp to compare

Returns:: bool

Definition at line 483 of file time.php.

References fromString(), and r().

TimeHelper::wasYesterday	(	$	dateString,
		$	userOffset = `null`
	)

Returns true if given datetime string was yesterday.

Parameters:

	string	$dateString Datetime string or Unix timestamp
	int	$userOffset User's offset from GMT (in hours)

Returns:: boolean True if datetime string was yesterday

Definition at line 204 of file time.php.

References fromString().

Referenced by niceShort().

The documentation for this class was generated from the following file:

1.2.x.x/cake/libs/view/helpers/time.php

The API

TimeHelper Class Reference

Public Member Functions

Detailed Description

Member Function Documentation