[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.date.php (summary)

(no description)

File Size: 405 lines (13 kb)
Included or required: 31 times
Referenced: 0 times
Includes or requires: 2 files
 include/class.auth.php
 include/class.prefs.php

Defines 1 class

Date_API:: (19 methods):
  isAM()
  isPM()
  getCurrentUnixTimestampGMT()
  getFormattedDateDiff()
  getUnixTimestamp()
  getRFC822Date()
  getCurrentDateGMT()
  getTimezoneList()
  getTimezoneShortName()
  getTimezoneShortNameByUser()
  getFormattedDate()
  getSimpleDate()
  getPreferredTimezone()
  getDefaultTimezone()
  getDateGMT()
  getDateGMTByTS()
  getWeekOptions()
  getCurrentWeek()
  formatWeekOption()


Class: Date_API  - X-Ref

Class to handle date convertion issues, which enable the
application of storing all dates in GMT dates and allowing each
user to specify a timezone that is supposed to be used across the
pages.

isAM($hour)   X-Ref
Returns whether the given hour is AM or not.

param: integer $hour The hour number
return: boolean

isPM($hour)   X-Ref
Returns whether the given hour is PM or not.

param: integer $hour The hour number
return: boolean

getCurrentUnixTimestampGMT()   X-Ref
Returns the current UNIX timestamp in the GMT timezone.

return: integer The current UNIX timestamp in GMT

getFormattedDateDiff($now_ts, $old_ts)   X-Ref
Method used to get a pretty-like formatted time output for the
difference in time between two unix timestamps.

param: integer $now_ts The current UNIX timestamp
param: integer $old_ts The old UNIX timestamp
return: string The formatted difference in time

getUnixTimestamp($timestamp, $timezone = FALSE)   X-Ref
Method used to get the user's current time (timezone included) as
a UNIX timestamp.

param: integer $timestamp The current UNIX timestamp
param: string $timezone The needed timezone
return: integer The UNIX timestamp representing the user's current time

getRFC822Date($timestamp, $timezone = FALSE)   X-Ref
Method used to get the current date in the GMT timezone in an
RFC822 compliant format.

param: string $timezone The needed timezone
return: string The current GMT date

getCurrentDateGMT()   X-Ref
Method used to get the current date in the GMT timezone.

return: string The current GMT date

getTimezoneList()   X-Ref
Method used to get the full list of available timezones to be
presented to the user.

return: array The list of timezones

getTimezoneShortName($date)   X-Ref
Method used to get the proper short name for a given date.

param: object $date The Date object
return: string The timezone short name

getTimezoneShortNameByUser($usr_id)   X-Ref
Method used to get the proper timezone short name for the current date
and time on the given user's timezone.

param: object $date The Date object
return: string The timezone short name

getFormattedDate($timestamp, $timezone = FALSE)   X-Ref
Method used to get the formatted date for a specific timestamp
and a specific timezone, provided by the user' preference.

param: string $timestamp The date timestamp to be formatted
param: string $timezone The timezone name
return: string

getSimpleDate($timestamp, $convert = true)   X-Ref
Method used to get the formatted date for a specific timestamp
and a specific timezone, provided by the user' preference.

param: string $timestamp The date timestamp to be formatted
param: boolean $convert If the timestamp should be converted to the preferred timezone
return: string

getPreferredTimezone($usr_id = FALSE)   X-Ref
Method used to get the timezone preferred by the user.

param: integer $usr_id The user ID
return: string The timezone preferred by the user

getDefaultTimezone()   X-Ref
Method used to get the application default timezone.

return: string The default timezone

getDateGMT($date)   X-Ref
Method used to convert the user date (that might be in a
specific timezone) to a GMT date.

param: string $date The user based date
return: string The date in the GMT timezone

getDateGMTByTS($timestamp)   X-Ref
Method used to convert a unix timestamp date to a GMT date.

param: integer $timestamp The user based date
return: string The date in the GMT timezone

getWeekOptions($weeks_past, $weeks_future)   X-Ref
Returns a list of weeks (May 2 - May 8, May 9 - May 15).

param: integer $weeks_past The number of weeks in the past to include.
param: integer $weeks_future The number of weeks in the future to include.
return: array An array of weeks.

getCurrentWeek()   X-Ref
Returns the current week in the same format formatWeekOption users.

return: string A string containg the current week.

formatWeekOption($start)   X-Ref
Formats a given week start and week end to a format useable by getWeekOptions().

param: integer $start The start date of the week.
return: array An array usable as an option in getWeekOptions.



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7