PHPXRef 0.7.1 : moodle-2.8 : Detail view of Date.php

__construct($date = null, $part = null, $locale = null) X-Ref

Generates the standard date object, could be a unix timestamp, localized date,
string, integer, array and so on. Also parts of dates or time are supported
Always set the default timezone: http://php.net/date_default_timezone_set
For example, in your bootstrap: date_default_timezone_set('America/Los_Angeles');
For detailed instructions please look in the docu.

param: string|integer|Zend_Date|array  $date    OPTIONAL Date value or value of date part to set
param: string                          $part    OPTIONAL Defines the input format of $date
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date

setOptions(array $options = array() X-Ref

Sets class wide options, if no option was given, the actual set options will be returned

param: array $options Options to set
return: Options array if no option was given

getTimestamp() X-Ref

Returns this object's internal UNIX timestamp (equivalent to Zend_Date::TIMESTAMP).
If the timestamp is too large for integers, then the return value will be a string.
This function does not return the timestamp as an object.
Use clone() or copyPart() instead.

return: integer|string UNIX timestamp

_timestamp($calc, $stamp) X-Ref

Returns the calculated timestamp
HINT: timestamps are always GMT

param: string $calc Type of calculation to make
param: string|integer|array|Zend_Date $stamp Timestamp to calculate, when null the actual timestamp is calculated
return: Zend_Date|integer

setTimestamp($timestamp) X-Ref

Sets a new timestamp

param: integer|string|array|Zend_Date $timestamp Timestamp to set
return: Zend_Date Provides fluid interface

addTimestamp($timestamp) X-Ref

Adds a timestamp

param: integer|string|array|Zend_Date $timestamp Timestamp to add
return: Zend_Date Provides fluid interface

subTimestamp($timestamp) X-Ref

Subtracts a timestamp

param: integer|string|array|Zend_Date $timestamp Timestamp to sub
return: Zend_Date Provides fluid interface

compareTimestamp($timestamp) X-Ref

Compares two timestamps, returning the difference as integer

param: integer|string|array|Zend_Date $timestamp Timestamp to compare
return: integer 0 = equal, 1 = later, -1 = earlier

toString($format = null, $type = null, $locale = null) X-Ref

Returns a string representation of the object
Supported format tokens are:
G - era, y - year, Y - ISO year, M - month, w - week of year, D - day of year, d - day of month
E - day of week, e - number of weekday (1-7), h - hour 1-12, H - hour 0-23, m - minute, s - second
A - milliseconds of day, z - timezone, Z - timezone offset, S - fractional second, a - period of day

Additionally format tokens but non ISO conform are:
SS - day suffix, eee - php number of weekday(0-6), ddd - number of days per month
l - Leap year, B - swatch internet time, I - daylight saving time, X - timezone offset in seconds
r - RFC2822 format, U - unix timestamp

Not supported ISO tokens are
u - extended year, Q - quarter, q - quarter, L - stand alone month, W - week of month
F - day of week of month, g - modified julian, c - stand alone weekday, k - hour 0-11, K - hour 1-24
v - wall zone

param: string              $format  OPTIONAL Rule for formatting output. If null the default date format is used
param: string              $type    OPTIONAL Type for the format string which overrides the standard setting
param: string|Zend_Locale  $locale  OPTIONAL Locale for parsing input
return: string

__toString() X-Ref

Returns a string representation of the date which is equal with the timestamp

return: string

toValue($part = null) X-Ref

Returns a integer representation of the object
But returns false when the given part is no value f.e. Month-Name

param: string|integer|Zend_Date $part OPTIONAL Defines the date or datepart to return as integer
return: integer|false

toArray() X-Ref

Returns an array representation of the object

return: array

get($part = null, $locale = null) X-Ref

Returns a representation of a date or datepart
This could be for example a localized monthname, the time without date,
the era or only the fractional seconds. There are about 50 different supported date parts.
For a complete list of supported datepart values look into the docu

param: string              $part    OPTIONAL Part of the date to return, if null the timestamp is returned
param: string|Zend_Locale  $locale  OPTIONAL Locale for parsing input
return: string  date or datepart

_toToken($part, $locale) X-Ref

Internal method to apply tokens

param: string $part
param: string $locale
return: string

_parseIsoToDate($token, $locale) X-Ref

Internal parsing method

param: string $token
param: string $locale
return: string

_toComment($token) X-Ref

Private function to make a comment of a token

param: string $token
return: string

_getDigitFromName($name) X-Ref

Return digit from standard names (english)
Faster implementation than locale aware searching

param: string $name
return: integer Number of this month

getFullYear($value) X-Ref

Counts the exact year number
< 70 - 2000 added, >70 < 100 - 1900, others just returned

param: integer $value year number
return: integer Number of year

set($date, $part = null, $locale = null) X-Ref

Sets the given date as new date or a given datepart as new datepart returning the new datepart
This could be for example a localized dayname, the date without time,
the month or only the seconds. There are about 50 different supported date parts.
For a complete list of supported datepart values look into the docu

param: string|integer|array|Zend_Date  $date    Date or datepart to set
param: string                          $part    OPTIONAL Part of the date to set, if null the timestamp is set
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

add($date, $part = self::TIMESTAMP, $locale = null) X-Ref

Adds a date or datepart to the existing date, by extracting $part from $date,
and modifying this object by adding that part.  The $part is then extracted from
this object and returned as an integer or numeric string (for large values, or $part's
corresponding to pre-defined formatted date strings).
This could be for example a ISO 8601 date, the hour the monthname or only the minute.
There are about 50 different supported date parts.
For a complete list of supported datepart values look into the docu.

param: string|integer|array|Zend_Date  $date    Date or datepart to add
param: string                          $part    OPTIONAL Part of the date to add, if null the timestamp is added
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

sub($date, $part = self::TIMESTAMP, $locale = null) X-Ref

Subtracts a date from another date.
This could be for example a RFC2822 date, the time,
the year or only the timestamp. There are about 50 different supported date parts.
For a complete list of supported datepart values look into the docu
Be aware: Adding -2 Months is not equal to Subtracting 2 Months !!!

param: string|integer|array|Zend_Date  $date    Date or datepart to subtract
param: string                          $part    OPTIONAL Part of the date to sub, if null the timestamp is subtracted
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compare($date, $part = self::TIMESTAMP, $locale = null) X-Ref

Compares a date or datepart with the existing one.
Returns -1 if earlier, 0 if equal and 1 if later.

param: string|integer|array|Zend_Date  $date    Date or datepart to compare with the date object
param: string                          $part    OPTIONAL Part of the date to compare, if null the timestamp is subtracted
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

copyPart($part, $locale = null) X-Ref

Returns a new instance of Zend_Date with the selected part copied.
To make an exact copy, use PHP's clone keyword.
For a complete list of supported date part values look into the docu.
If a date part is copied, all other date parts are set to standard values.
For example: If only YEAR is copied, the returned date object is equal to
01-01-YEAR 00:00:00 (01-01-1970 00:00:00 is equal to timestamp 0)
If only HOUR is copied, the returned date object is equal to
01-01-1970 HOUR:00:00 (so $this contains a timestamp equal to a timestamp of 0 plus HOUR).

param: string $part Part of the date to compare, if null the timestamp is subtracted
param: string|Zend_Locale $locale OPTIONAL New object's locale. No adjustments to timezone are made.
return: Zend_Date New clone with requested part

getTimezoneFromString($zone) X-Ref

Internal function, returns the offset of a given timezone

param: string $zone
return: integer

_assign($calc, $date, $comp = 0, $dst = false) X-Ref

Calculates the date or object

param: string                    $calc  Calculation to make
param: string|integer            $date  Date for calculation
param: string|integer            $comp  Second date for calculation
param: boolean|integer           $dst   Use dst correction if option is set
return: integer|string|Zend_Date  new timestamp or Zend_Date depending on calculation

_calculate($calc, $date, $part, $locale) X-Ref

Calculates the date or object

param: string                          $calc    Calculation to make, one of: 'add'|'sub'|'cmp'|'copy'|'set'
param: string|integer|array|Zend_Date  $date    Date or datepart to calculate with
param: string                          $part    Part of the date to calculate, if null the timestamp is used
param: string|Zend_Locale              $locale  Locale for parsing input
return: integer|string|Zend_Date        new timestamp

equals($date, $part = self::TIMESTAMP, $locale = null) X-Ref

Returns true when both date objects or date parts are equal.
For example:
15.May.2000 <-> 15.June.2000 Equals only for Day or Year... all other will return false

param: string|integer|array|Zend_Date  $date    Date or datepart to equal with
param: string                          $part    OPTIONAL Part of the date to compare, if null the timestamp is used
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: boolean

isEarlier($date, $part = null, $locale = null) X-Ref

Returns if the given date or datepart is earlier
For example:
15.May.2000 <-> 13.June.1999 will return true for day, year and date, but not for month

param: string|integer|array|Zend_Date  $date    Date or datepart to compare with
param: string                          $part    OPTIONAL Part of the date to compare, if null the timestamp is used
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: boolean

isLater($date, $part = null, $locale = null) X-Ref

Returns if the given date or datepart is later
For example:
15.May.2000 <-> 13.June.1999 will return true for month but false for day, year and date
Returns if the given date is later

param: string|integer|array|Zend_Date  $date    Date or datepart to compare with
param: string                          $part    OPTIONAL Part of the date to compare, if null the timestamp is used
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: boolean

getTime($locale = null) X-Ref

Returns only the time of the date as new Zend_Date object
For example:
15.May.2000 10:11:23 will return a dateobject equal to 01.Jan.1970 10:11:23

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

_time($calc, $time, $format, $locale) X-Ref

Returns the calculated time

param: string                    $calc    Calculation to make
param: string|integer|array|Zend_Date  $time    Time to calculate with, if null the actual time is taken
param: string                          $format  Timeformat for parsing input
param: string|Zend_Locale              $locale  Locale for parsing input
return: integer|Zend_Date  new time

setTime($time, $format = null, $locale = null) X-Ref

Sets a new time for the date object. Format defines how to parse the time string.
Also a complete date can be given, but only the time is used for setting.
For example: dd.MMMM.yyTHH:mm' and 'ss sec'-> 10.May.07T25:11 and 44 sec => 1h11min44sec + 1 day
Returned is the new date object and the existing date is left as it was before

param: string|integer|array|Zend_Date  $time    Time to set
param: string                          $format  OPTIONAL Timeformat for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addTime($time, $format = null, $locale = null) X-Ref

Adds a time to the existing date. Format defines how to parse the time string.
If only parts are given the other parts are set to 0.
If no format is given, the standardformat of this locale is used.
For example: HH:mm:ss -> 10 -> +10 hours

param: string|integer|array|Zend_Date  $time    Time to add
param: string                          $format  OPTIONAL Timeformat for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subTime($time, $format = null, $locale = null) X-Ref

Subtracts a time from the existing date. Format defines how to parse the time string.
If only parts are given the other parts are set to 0.
If no format is given, the standardformat of this locale is used.
For example: HH:mm:ss -> 10 -> -10 hours

param: string|integer|array|Zend_Date  $time    Time to sub
param: string                          $format  OPTIONAL Timeformat for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid inteface

compareTime($time, $format = null, $locale = null) X-Ref

Compares the time from the existing date. Format defines how to parse the time string.
If only parts are given the other parts are set to default.
If no format us given, the standardformat of this locale is used.
For example: HH:mm:ss -> 10 -> 10 hours

param: string|integer|array|Zend_Date  $time    Time to compare
param: string                          $format  OPTIONAL Timeformat for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getDate($locale = null) X-Ref

Returns a clone of $this, with the time part set to 00:00:00.

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

_date($calc, $date, $format, $locale) X-Ref

Returns the calculated date

param: string                          $calc    Calculation to make
param: string|integer|array|Zend_Date  $date    Date to calculate with, if null the actual date is taken
param: string                          $format  Date format for parsing
param: string|Zend_Locale              $locale  Locale for parsing input
return: integer|Zend_Date  new date

setDate($date, $format = null, $locale = null) X-Ref

Sets a new date for the date object. Format defines how to parse the date string.
Also a complete date with time can be given, but only the date is used for setting.
For example: MMMM.yy HH:mm-> May.07 22:11 => 01.May.07 00:00
Returned is the new date object and the existing time is left as it was before

param: string|integer|array|Zend_Date  $date    Date to set
param: string                          $format  OPTIONAL Date format for parsing
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addDate($date, $format = null, $locale = null) X-Ref

Adds a date to the existing date object. Format defines how to parse the date string.
If only parts are given the other parts are set to 0.
If no format is given, the standardformat of this locale is used.
For example: MM.dd.YYYY -> 10 -> +10 months

param: string|integer|array|Zend_Date  $date    Date to add
param: string                          $format  OPTIONAL Date format for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subDate($date, $format = null, $locale = null) X-Ref

Subtracts a date from the existing date object. Format defines how to parse the date string.
If only parts are given the other parts are set to 0.
If no format is given, the standardformat of this locale is used.
For example: MM.dd.YYYY -> 10 -> -10 months
Be aware: Subtracting 2 months is not equal to Adding -2 months !!!

param: string|integer|array|Zend_Date  $date    Date to sub
param: string                          $format  OPTIONAL Date format for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareDate($date, $format = null, $locale = null) X-Ref

Compares the date from the existing date object, ignoring the time.
Format defines how to parse the date string.
If only parts are given the other parts are set to 0.
If no format is given, the standardformat of this locale is used.
For example: 10.01.2000 => 10.02.1999 -> false

param: string|integer|array|Zend_Date  $date    Date to compare
param: string                          $format  OPTIONAL Date format for parsing input
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getIso($locale = null) X-Ref

Returns the full ISO 8601 date from the date object.
Always the complete ISO 8601 specifiction is used. If an other ISO date is needed
(ISO 8601 defines several formats) use toString() instead.
This function does not return the ISO date as object. Use copy() instead.

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: string

setIso($date, $locale = null) X-Ref

Sets a new date for the date object. Not given parts are set to default.
Only supported ISO 8601 formats are accepted.
For example: 050901 -> 01.Sept.2005 00:00:00, 20050201T10:00:30 -> 01.Feb.2005 10h00m30s
Returned is the new date object

param: string|integer|Zend_Date $date ISO Date to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addIso($date, $locale = null) X-Ref

Adds a ISO date to the date object. Not given parts are set to default.
Only supported ISO 8601 formats are accepted.
For example: 050901 -> + 01.Sept.2005 00:00:00, 10:00:00 -> +10h
Returned is the new date object

param: string|integer|Zend_Date $date ISO Date to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subIso($date, $locale = null) X-Ref

Subtracts a ISO date from the date object. Not given parts are set to default.
Only supported ISO 8601 formats are accepted.
For example: 050901 -> - 01.Sept.2005 00:00:00, 10:00:00 -> -10h
Returned is the new date object

param: string|integer|Zend_Date $date ISO Date to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareIso($date, $locale = null) X-Ref

Compares a ISO date with the date object. Not given parts are set to default.
Only supported ISO 8601 formats are accepted.
For example: 050901 -> - 01.Sept.2005 00:00:00, 10:00:00 -> -10h
Returns if equal, earlier or later

param: string|integer|Zend_Date  $date    ISO Date to sub
param: string|Zend_Locale        $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getArpa($locale = null) X-Ref

Returns a RFC 822 compilant datestring from the date object.
This function does not return the RFC date as object. Use copy() instead.

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: string

setArpa($date, $locale = null) X-Ref

Sets a RFC 822 date as new date for the date object.
Only RFC 822 compilant date strings are accepted.
For example: Sat, 14 Feb 09 00:31:30 +0100
Returned is the new date object

param: string|integer|Zend_Date $date RFC 822 to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addArpa($date, $locale = null) X-Ref

Adds a RFC 822 date to the date object.
ARPA messages are used in emails or HTTP Headers.
Only RFC 822 compilant date strings are accepted.
For example: Sat, 14 Feb 09 00:31:30 +0100
Returned is the new date object

param: string|integer|Zend_Date $date RFC 822 Date to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subArpa($date, $locale = null) X-Ref

Subtracts a RFC 822 date from the date object.
ARPA messages are used in emails or HTTP Headers.
Only RFC 822 compilant date strings are accepted.
For example: Sat, 14 Feb 09 00:31:30 +0100
Returned is the new date object

param: string|integer|Zend_Date $date RFC 822 Date to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareArpa($date, $locale = null) X-Ref

Compares a RFC 822 compilant date with the date object.
ARPA messages are used in emails or HTTP Headers.
Only RFC 822 compilant date strings are accepted.
For example: Sat, 14 Feb 09 00:31:30 +0100
Returns if equal, earlier or later

param: string|integer|Zend_Date  $date    RFC 822 Date to sub
param: string|Zend_Locale        $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

_checkLocation($location) X-Ref

Check if location is supported

param: $location array - locations array
return: $horizon float

getSunrise($location) X-Ref

Returns the time of sunrise for this date and a given location as new date object
For a list of cities and correct locations use the class Zend_Date_Cities

param: $location array - location of sunrise
return: Zend_Date

getSunset($location) X-Ref

Returns the time of sunset for this date and a given location as new date object
For a list of cities and correct locations use the class Zend_Date_Cities

param: $location array - location of sunset
return: Zend_Date

getSunInfo($location) X-Ref

Returns an array with the sunset and sunrise dates for all horizon types
For a list of cities and correct locations use the class Zend_Date_Cities

param: $location array - location of suninfo
return: array - [sunset|sunrise][effective|civil|nautic|astronomic]

checkLeapYear($year) X-Ref

Check a given year for leap year.

param: integer|array|Zend_Date $year Year to check
return: boolean

isLeapYear() X-Ref

Returns true, if the year is a leap year.

return: boolean

isToday() X-Ref

Returns if the set date is todays date

return: boolean

isYesterday() X-Ref

Returns if the set date is yesterdays date

return: boolean

isTomorrow() X-Ref

Returns if the set date is tomorrows date

return: boolean

now($locale = null) X-Ref

Returns the actual date as new date object

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

_calcdetail($calc, $date, $type, $locale) X-Ref

Calculate date details

param: string                          $calc    Calculation to make
param: string|integer|array|Zend_Date  $date    Date or Part to calculate
param: string                          $part    Datepart for Calculation
param: string|Zend_Locale              $locale  Locale for parsing input
return: integer|string  new date

_calcvalue($calc, $value, $type, $parameter, $locale) X-Ref

Internal calculation, returns the requested date type

param: string                    $calc    Calculation to make
param: string|integer|Zend_Date  $value   Datevalue to calculate with, if null the actual value is taken
param: string|Zend_Locale        $locale  Locale for parsing input
return: integer|Zend_Date  new date

getYear($locale = null) X-Ref

Returns only the year from the date object as new object.
For example: 10.May.2000 10:30:00 -> 01.Jan.2000 00:00:00

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

setYear($year, $locale = null) X-Ref

Sets a new year
If the year is between 0 and 69, 2000 will be set (2000-2069)
If the year if between 70 and 99, 1999 will be set (1970-1999)
3 or 4 digit years are set as expected. If you need to set year 0-99
use set() instead.
Returned is the new date object

param: string|integer|array|Zend_Date $date Year to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addYear($year, $locale = null) X-Ref

Adds the year to the existing date object
If the year is between 0 and 69, 2000 will be added (2000-2069)
If the year if between 70 and 99, 1999 will be added (1970-1999)
3 or 4 digit years are added as expected. If you need to add years from 0-99
use add() instead.
Returned is the new date object

param: string|integer|array|Zend_Date $date Year to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subYear($year, $locale = null) X-Ref

Subs the year from the existing date object
If the year is between 0 and 69, 2000 will be subtracted (2000-2069)
If the year if between 70 and 99, 1999 will be subtracted (1970-1999)
3 or 4 digit years are subtracted as expected. If you need to subtract years from 0-99
use sub() instead.
Returned is the new date object

param: string|integer|array|Zend_Date $date Year to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareYear($year, $locale = null) X-Ref

Compares the year with the existing date object, ignoring other date parts.
For example: 10.03.2000 -> 15.02.2000 -> true
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $year    Year to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getMonth($locale = null) X-Ref

Returns only the month from the date object as new object.
For example: 10.May.2000 10:30:00 -> 01.May.1970 00:00:00

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

_month($calc, $month, $locale) X-Ref

Returns the calculated month

param: string                          $calc    Calculation to make
param: string|integer|array|Zend_Date  $month   Month to calculate with, if null the actual month is taken
param: string|Zend_Locale              $locale  Locale for parsing input
return: integer|Zend_Date  new time

setMonth($month, $locale = null) X-Ref

Sets a new month
The month can be a number or a string. Setting months lower then 0 and greater then 12
will result in adding or subtracting the relevant year. (12 months equal one year)
If a localized monthname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object

param: string|integer|array|Zend_Date $month Month to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addMonth($month, $locale = null) X-Ref

Adds months to the existing date object.
The month can be a number or a string. Adding months lower then 0 and greater then 12
will result in adding or subtracting the relevant year. (12 months equal one year)
If a localized monthname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object

param: string|integer|array|Zend_Date $month Month to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subMonth($month, $locale = null) X-Ref

Subtracts months from the existing date object.
The month can be a number or a string. Subtracting months lower then 0 and greater then 12
will result in adding or subtracting the relevant year. (12 months equal one year)
If a localized monthname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object

param: string|integer|array|Zend_Date $month Month to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareMonth($month, $locale = null) X-Ref

Compares the month with the existing date object, ignoring other date parts.
For example: 10.03.2000 -> 15.03.1950 -> true
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $month   Month to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getDay($locale = null) X-Ref

Returns the day as new date object
Example: 20.May.1986 -> 20.Jan.1970 00:00:00

param: $locale string|Zend_Locale OPTIONAL Locale for parsing input
return: Zend_Date

_day($calc, $day, $locale) X-Ref

Returns the calculated day

param: $calc    string                    Type of calculation to make
param: $day     string|integer|Zend_Date  Day to calculate, when null the actual day is calculated
param: $locale  string|Zend_Locale        Locale for parsing input
return: Zend_Date|integer

setDay($day, $locale = null) X-Ref

Sets a new day
The day can be a number or a string. Setting days lower then 0 or greater than the number of this months days
will result in adding or subtracting the relevant month.
If a localized dayname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object
Example: setDay('Montag', 'de_AT'); will set the monday of this week as day.

param: string|integer|array|Zend_Date $month Day to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addDay($day, $locale = null) X-Ref

Adds days to the existing date object.
The day can be a number or a string. Adding days lower then 0 or greater than the number of this months days
will result in adding or subtracting the relevant month.
If a localized dayname is given it will be parsed with the default locale or the optional
set locale.

param: string|integer|array|Zend_Date $month Day to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subDay($day, $locale = null) X-Ref

Subtracts days from the existing date object.
The day can be a number or a string. Subtracting days lower then 0 or greater than the number of this months days
will result in adding or subtracting the relevant month.
If a localized dayname is given it will be parsed with the default locale or the optional
set locale.

param: string|integer|array|Zend_Date $month Day to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareDay($day, $locale = null) X-Ref

Compares the day with the existing date object, ignoring other date parts.
For example: 'Monday', 'en' -> 08.Jan.2007 -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $day     Day to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getWeekday($locale = null) X-Ref

Returns the weekday as new date object
Weekday is always from 1-7
Example: 09-Jan-2007 -> 2 = Tuesday -> 02-Jan-1970 (when 02.01.1970 is also Tuesday)

param: $locale string|Zend_Locale OPTIONAL Locale for parsing input
return: Zend_Date

_weekday($calc, $weekday, $locale) X-Ref

Returns the calculated weekday

param: $calc     string                          Type of calculation to make
param: $weekday  string|integer|array|Zend_Date  Weekday to calculate, when null the actual weekday is calculated
param: $locale   string|Zend_Locale              Locale for parsing input
return: Zend_Date|integer

setWeekday($weekday, $locale = null) X-Ref

Sets a new weekday
The weekday can be a number or a string. If a localized weekday name is given,
then it will be parsed as a date in $locale (defaults to the same locale as $this).
Returned is the new date object.
Example: setWeekday(3); will set the wednesday of this week as day.

param: string|integer|array|Zend_Date $month Weekday to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addWeekday($weekday, $locale = null) X-Ref

Adds weekdays to the existing date object.
The weekday can be a number or a string.
If a localized dayname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object
Example: addWeekday(3); will add the difference of days from the begining of the month until
wednesday.

param: string|integer|array|Zend_Date $month Weekday to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subWeekday($weekday, $locale = null) X-Ref

Subtracts weekdays from the existing date object.
The weekday can be a number or a string.
If a localized dayname is given it will be parsed with the default locale or the optional
set locale.
Returned is the new date object
Example: subWeekday(3); will subtract the difference of days from the begining of the month until
wednesday.

param: string|integer|array|Zend_Date $month Weekday to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareWeekday($weekday, $locale = null) X-Ref

Compares the weekday with the existing date object, ignoring other date parts.
For example: 'Monday', 'en' -> 08.Jan.2007 -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $weekday  Weekday to compare
param: string|Zend_Locale              $locale   OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getDayOfYear($locale = null) X-Ref

Returns the day of year as new date object
Example: 02.Feb.1986 10:00:00 -> 02.Feb.1970 00:00:00

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

setDayOfYear($day, $locale = null) X-Ref

Sets a new day of year
The day of year is always a number.
Returned is the new date object
Example: 04.May.2004 -> setDayOfYear(10) -> 10.Jan.2004

param: string|integer|array|Zend_Date $day Day of Year to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addDayOfYear($day, $locale = null) X-Ref

Adds a day of year to the existing date object.
The day of year is always a number.
Returned is the new date object
Example: addDayOfYear(10); will add 10 days to the existing date object.

param: string|integer|array|Zend_Date $day Day of Year to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subDayOfYear($day, $locale = null) X-Ref

Subtracts a day of year from the existing date object.
The day of year is always a number.
Returned is the new date object
Example: subDayOfYear(10); will subtract 10 days from the existing date object.

param: string|integer|array|Zend_Date $day Day of Year to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareDayOfYear($day, $locale = null) X-Ref

Compares the day of year with the existing date object.
For example: compareDayOfYear(33) -> 02.Feb.2007 -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $day     Day of Year to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getHour($locale = null) X-Ref

Returns the hour as new date object
Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 10:00:00

param: $locale string|Zend_Locale OPTIONAL Locale for parsing input
return: Zend_Date

setHour($hour, $locale = null) X-Ref

Sets a new hour
The hour is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> setHour(7); -> 04.May.1993 07:07:25

param: string|integer|array|Zend_Date $hour Hour to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addHour($hour, $locale = null) X-Ref

Adds hours to the existing date object.
The hour is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> addHour(12); -> 05.May.1993 01:07:25

param: string|integer|array|Zend_Date $hour Hour to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subHour($hour, $locale = null) X-Ref

Subtracts hours from the existing date object.
The hour is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> subHour(6); -> 05.May.1993 07:07:25

param: string|integer|array|Zend_Date $hour Hour to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareHour($hour, $locale = null) X-Ref

Compares the hour with the existing date object.
For example: 10:30:25 -> compareHour(10) -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $hour    Hour to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getMinute($locale = null) X-Ref

Returns the minute as new date object
Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:30:00

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

setMinute($minute, $locale = null) X-Ref

Sets a new minute
The minute is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> setMinute(29); -> 04.May.1993 13:29:25

param: string|integer|array|Zend_Date $minute Minute to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addMinute($minute, $locale = null) X-Ref

Adds minutes to the existing date object.
The minute is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> addMinute(65); -> 04.May.1993 13:12:25

param: string|integer|array|Zend_Date $minute Minute to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subMinute($minute, $locale = null) X-Ref

Subtracts minutes from the existing date object.
The minute is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> subMinute(9); -> 04.May.1993 12:58:25

param: string|integer|array|Zend_Date $minute Minute to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareMinute($minute, $locale = null) X-Ref

Compares the minute with the existing date object.
For example: 10:30:25 -> compareMinute(30) -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date  $minute  Hour to compare
param: string|Zend_Locale              $locale  OPTIONAL Locale for parsing input
return: integer  0 = equal, 1 = later, -1 = earlier

getSecond($locale = null) X-Ref

Returns the second as new date object
Example: 02.Feb.1986 10:30:25 -> 01.Jan.1970 00:00:25

param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date

setSecond($second, $locale = null) X-Ref

Sets new seconds to the existing date object.
The second is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> setSecond(100); -> 04.May.1993 13:08:40

param: string|integer|array|Zend_Date $second Second to set
param: string|Zend_Locale $locale (Optional) Locale for parsing input
return: Zend_Date Provides fluid interface

addSecond($second, $locale = null) X-Ref

Adds seconds to the existing date object.
The second is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> addSecond(65); -> 04.May.1993 13:08:30

param: string|integer|array|Zend_Date $second Second to add
param: string|Zend_Locale $locale (Optional) Locale for parsing input
return: Zend_Date Provides fluid interface

subSecond($second, $locale = null) X-Ref

Subtracts seconds from the existing date object.
The second is always a number.
Returned is the new date object
Example: 04.May.1993 13:07:25 -> subSecond(10); -> 04.May.1993 13:07:15

param: string|integer|array|Zend_Date $second Second to sub
param: string|Zend_Locale $locale (Optional) Locale for parsing input
return: Zend_Date Provides fluid interface

compareSecond($second, $locale = null) X-Ref

Compares the second with the existing date object.
For example: 10:30:25 -> compareSecond(25) -> 0
Returns if equal, earlier or later

param: string|integer|array|Zend_Date $second Second to compare
param: string|Zend_Locale $locale (Optional) Locale for parsing input
return: integer 0 = equal, 1 = later, -1 = earlier

getFractionalPrecision() X-Ref

Returns the precision for fractional seconds

return: integer

setFractionalPrecision($precision) X-Ref

Sets a new precision for fractional seconds

param: integer $precision Precision for the fractional datepart 3 = milliseconds
return: Zend_Date Provides fluid interface

getMilliSecond() X-Ref

Returns the milliseconds of the date object

return: string

setMilliSecond($milli = null, $precision = null) X-Ref

Sets new milliseconds for the date object
Example: setMilliSecond(550, 2) -> equals +5 Sec +50 MilliSec

param: integer|Zend_Date $milli (Optional) Millisecond to set, when null the actual millisecond is set
param: integer $precision (Optional) Fraction precision of the given milliseconds
return: Zend_Date Provides fluid interface

addMilliSecond($milli = null, $precision = null) X-Ref

Adds milliseconds to the date object

param: integer|Zend_Date $milli (Optional) Millisecond to add, when null the actual millisecond is added
param: integer $precision (Optional) Fractional precision for the given milliseconds
return: Zend_Date Provides fluid interface

subMilliSecond($milli = null, $precision = null) X-Ref

Subtracts a millisecond

param: integer|Zend_Date $milli (Optional) Millisecond to sub, when null the actual millisecond is subtracted
param: integer $precision (Optional) Fractional precision for the given milliseconds
return: Zend_Date Provides fluid interface

compareMilliSecond($milli = null, $precision = null) X-Ref

Compares only the millisecond part, returning the difference

param: integer|Zend_Date  $milli  OPTIONAL Millisecond to compare, when null the actual millisecond is compared
param: integer            $precision  OPTIONAL Fractional precision for the given milliseconds
return: integer  0 = equal, 1 = later, -1 = earlier

getWeek($locale = null) X-Ref

Returns the week as new date object using monday as begining of the week
Example: 12.Jan.2007 -> 08.Jan.1970 00:00:00

param: $locale string|Zend_Locale OPTIONAL Locale for parsing input
return: Zend_Date

setWeek($week, $locale = null) X-Ref

Sets a new week. The week is always a number. The day of week is not changed.
Returned is the new date object
Example: 09.Jan.2007 13:07:25 -> setWeek(1); -> 02.Jan.2007 13:07:25

param: string|integer|array|Zend_Date $week Week to set
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

addWeek($week, $locale = null) X-Ref

Adds a week. The week is always a number. The day of week is not changed.
Returned is the new date object
Example: 09.Jan.2007 13:07:25 -> addWeek(1); -> 16.Jan.2007 13:07:25

param: string|integer|array|Zend_Date $week Week to add
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

subWeek($week, $locale = null) X-Ref

Subtracts a week. The week is always a number. The day of week is not changed.
Returned is the new date object
Example: 09.Jan.2007 13:07:25 -> subWeek(1); -> 02.Jan.2007 13:07:25

param: string|integer|array|Zend_Date $week Week to sub
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: Zend_Date Provides fluid interface

compareWeek($week, $locale = null) X-Ref

Compares only the week part, returning the difference
Returned is the new date object
Returns if equal, earlier or later
Example: 09.Jan.2007 13:07:25 -> compareWeek(2); -> 0

param: string|integer|array|Zend_Date $week Week to compare
param: string|Zend_Locale $locale OPTIONAL Locale for parsing input
return: integer 0 = equal, 1 = later, -1 = earlier

setLocale($locale = null) X-Ref

Sets a new standard locale for the date object.
This locale will be used for all functions
Returned is the really set locale.
Example: 'de_XX' will be set to 'de' because 'de_XX' does not exist
'xx_YY' will be set to 'root' because 'xx' does not exist

param: string|Zend_Locale $locale (Optional) Locale for parsing input
return: Zend_Date Provides fluent interface

getLocale() X-Ref

Returns the actual set locale

return: string

isDate($date, $format = null, $locale = null) X-Ref

Checks if the given date is a real date or datepart.
Returns false if a expected datepart is missing or a datepart exceeds its possible border.
But the check will only be done for the expected dateparts which are given by format.
If no format is given the standard dateformat for the actual locale is used.
f.e. 30.February.2007 will return false if format is 'dd.MMMM.YYYY'

param: string|array|Zend_Date $date   Date to parse for correctness
param: string                 $format (Optional) Format for parsing the date string
param: string|Zend_Locale     $locale (Optional) Locale for parsing date parts
return: boolean                True when all date parts are correct

_getLocalizedToken($token, $locale) X-Ref

Returns the ISO Token for all localized constants

param: string $token Token to normalize
param: string $locale Locale to search
return: string

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:	4953 lines (198 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

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

Defines 1 class