[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Date/ -> DateObject.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 1058 lines (39 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions

  setUnixTimestamp()
  getUnixTimestamp()
  _getTime()
  mktime()
  isYearLeapYear()
  date()
  dayOfWeek()
  getDateParts()
  weekNumber()
  _range()
  calcSun()
  setTimezone()
  getTimezone()
  getGmtOffset()

Functions
Functions that are not part of a class:

setUnixTimestamp($timestamp = null)   X-Ref
Set this object to have a new UNIX timestamp.

param: string|integer  $timestamp  OPTIONAL timestamp; defaults to local time using time()
return: string|integer  old timestamp

getUnixTimestamp()   X-Ref
Returns this object's UNIX timestamp
A timestamp greater then the integer range will be returned as string
This function does not return the timestamp as object. Use copy() instead.

return: integer|string  timestamp

_getTime($sync = null)   X-Ref
Internal function.
Returns time().  This method exists to allow unit tests to work-around methods that might otherwise
be hard-coded to use time().  For example, this makes it possible to test isYesterday() in Date.php.

param: integer  $sync      OPTIONAL time syncronisation value
return: integer  timestamp

mktime($hour, $minute, $second, $month, $day, $year, $gmt = false)   X-Ref
Internal mktime function used by Zend_Date.
The timestamp returned by mktime() can exceed the precision of traditional UNIX timestamps,
by allowing PHP to auto-convert to using a float value.

Returns a timestamp relative to 1970/01/01 00:00:00 GMT/UTC.
DST (Summer/Winter) is depriciated since php 5.1.0.
Year has to be 4 digits otherwise it would be recognised as
year 70 AD instead of 1970 AD as expected !!

param: integer  $hour
param: integer  $minute
param: integer  $second
param: integer  $month
param: integer  $day
param: integer  $year
param: boolean  $gmt     OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date
return: integer|float  timestamp (number of seconds elapsed relative to 1970/01/01 00:00:00 GMT/UTC)

isYearLeapYear($year)   X-Ref
Returns true, if given $year is a leap year.

param: integer  $year
return: boolean  true, if year is leap year

date($format, $timestamp = null, $gmt = false)   X-Ref
Internal mktime function used by Zend_Date for handling 64bit timestamps.

Returns a formatted date for a given timestamp.

param: string   $format     format for output
param: mixed    $timestamp
param: boolean  $gmt        OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date
return: string

dayOfWeek($year, $month, $day)   X-Ref
Returns the day of week for a Gregorian calendar date.
0 = sunday, 6 = saturday

param: integer  $year
param: integer  $month
param: integer  $day
return: integer  dayOfWeek

getDateParts($timestamp = null, $fast = null)   X-Ref
Internal getDateParts function for handling 64bit timestamps, similar to:
http://www.php.net/getdate

Returns an array of date parts for $timestamp, relative to 1970/01/01 00:00:00 GMT/UTC.

$fast specifies ALL date parts should be returned (slower)
Default is false, and excludes $dayofweek, weekday, month and timestamp from parts returned.

param: mixed    $timestamp
param: boolean  $fast   OPTIONAL defaults to fast (false), resulting in fewer date parts
return: array

weekNumber($year, $month, $day)   X-Ref
Internal getWeekNumber function for handling 64bit timestamps

Returns the ISO 8601 week number of a given date

param: integer  $year
param: integer  $month
param: integer  $day
return: integer

_range($a, $b)   X-Ref
Internal _range function
Sets the value $a to be in the range of [0, $b]

param: float $a - value to correct
param: float $b - maximum range to set

calcSun($location, $horizon, $rise = false)   X-Ref
Calculates the sunrise or sunset based on a location

param: array  $location  Location for calculation MUST include 'latitude', 'longitude', 'horizon'
param: bool   $horizon   true: sunrise; false: sunset
return: mixed  - false: midnight sun, integer:

setTimezone($zone = null)   X-Ref
Sets a new timezone for calculation of $this object's gmt offset.
For a list of supported timezones look here: http://php.net/timezones
If no timezone can be detected or the given timezone is wrong UTC will be set.

param: string  $zone      OPTIONAL timezone for date calculation; defaults to date_default_timezone_get()
return: Zend_Date_DateObject Provides fluent interface

getTimezone()   X-Ref
Return the timezone of $this object.
The timezone is initially set when the object is instantiated.

return: string  actual set timezone string

getGmtOffset()   X-Ref
Return the offset to GMT of $this object's timezone.
The offset to GMT is initially set when the object is instantiated using the currently,
in effect, default timezone for PHP functions.

return: integer  seconds difference between GMT timezone and timezone when object was instantiated



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1