SMWTimeValue Class Reference
[SMWDataValues]

This datavalue captures values of dates and times, in many formats, throughout history and pre-history. More...

List of all members.

Public Member Functions

getShortWikiText ($linked=NULL)

Returns a short textual representation for this data value.

getShortHTMLText ($linker=NULL)

Returns a short textual representation for this data value.

getLongWikiText ($linked=NULL)

Return the long textual description of the value, as printed for example in the factbox.

getLongHTMLText ($linker=NULL)

Return the long textual description of the value, as printed for example in the factbox.

getWikiValue ()

isNumeric ()

Convenience method that checks if the value that is used to sort data of this type is numeric.

getYear ($calendarmodel=SMWDITime::CM_GREGORIAN)

Return the year number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

getMonth ($calendarmodel=SMWDITime::CM_GREGORIAN, $default=1)

Return the month number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

getDay ($calendarmodel=SMWDITime::CM_GREGORIAN, $default=1)

Return the day number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

getTimeString ($default= '00:00:00')

Return the time as a string.

getXMLSchemaDate ($mindefault=true)

getISO8601Date ($mindefault=true)

Compute a string representation that largely follows the ISO8601 standard of representing dates.

getMediaWikiDate ()

Use MediaWiki's date and time formatting.

getCaptionFromDataitem (SMWDITime $dataitem)

Compute a suitable string to display the given date item.

Static Public Member Functions

static parseTimeString ($string, &$hours, &$minutes, &$seconds, &$timeoffset)

Parse the given string to check if it encodes an international time.

Public Attributes

const J1582 = 2299160.5

Moment of switchover to Gregorian calendar.

const MJD_EPOCH = 2400000.5

Offset of Julian Days for Modified JD inputs.

const PREHISTORY = -10000

The year before which we do not accept anything but year numbers and largely discourage calendar models.

Protected Member Functions

parseUserValue ($value)

Initialise the datavalue from the given value string.

parseDateString ($string, &$datecomponents, &$calendarmodel, &$era, &$hours, &$minutes, &$seconds, &$timeoffset)

Parse the given string to check if it a date/time value.

interpretDateComponents ($datecomponents, &$date)

Validate and interpret the date components as retrieved when parsing a user input.

setDateFromParsedValues ($datecomponents, $calendarmodel, $era, $hours, $minutes, $seconds, $timeoffset)

Initialise data from the provided intermediate results after parsing, assuming that a conventional date notation is used.

getCalendarModel ($presetmodel, $year, $month, $day)

Determine the calender model under which an input should be interpreted based on the given input data.

loadDataItem (SMWDataItem $dataItem)

getDataForCalendarModel ($calendarmodel)

Get the current data in the specified calendar model.

getPreferredCaption ()

Compute a suitable string to display this date, taking into account the output format and the preferrable calendar models for the data.

Static Protected Member Functions

static parseMilTimeString ($string, &$hours, &$minutes, &$seconds)

Parse the given string to check if it encodes a "military time".

static parseMonthString ($string, &$monthname)

Parse the given string to check if it refers to the string name ot abbreviation of a month name.

static checkDateComponent ($component, &$numvalue)

Check which roles a string component might play in a date, and set the call-by-ref parameter to the proper numerical representation.

Protected Attributes

$m_dataitem_greg = null

$m_dataitem_jul = null

$m_wikivalue

Static Protected Attributes

static $m_months = array( 'January', 'February', 'March', 'April' , 'May' , 'June' , 'July' , 'August' , 'September' , 'October' , 'November' , 'December' )

static $m_monthsshort = array( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' )

static $m_formats = array( SMW_Y => array( 'y' ), SMW_YM => array( 'y', 'm' ), SMW_MY => array( 'm', 'y' ), SMW_YDM => array( 'y', 'd', 'm' ), SMW_YMD => array( 'y', 'm', 'd' ), SMW_DMY => array( 'd', 'm', 'y' ), SMW_MDY => array( 'm', 'd', 'y' ) )

static $m_tz

General purpose time zone monikers and their associated offsets in hours and fractions of hours.

static $m_miltz

Military time zone monikers and their associated offsets in hours.

Detailed Description

This datavalue captures values of dates and times, in many formats, throughout history and pre-history.

The implementation can handle dates across history with full precision for storing, and substantial precision for sorting and querying. The range of supported past dates should encompass the Beginning of Time according to most of today's theories. The range of supported future dates is limited more strictly, but it does also allow year numbers in the order of 10^9.

The implementation notices and stores whether parts of a date/time have been omitted (as in "2008" or "May 2007"). For all exporting and sorting purposes, incomplete dates are completed with defaults (usually using the earliest possible time, i.e. interpreting "2008" as "Jan 1 2008 00:00:00"). The information on what was unspecified is kept internally for improving behaviour e.g. for outputs (defaults are not printed when querying for a value). This largely uses the precision handling of SMWDITime.

Date formats

Dates can be given in many formats, using numbers, month names, and abbreviated month names. The preferred interpretation of ambiguous dates ("1 2 2008" or even "1 2 3 BC") is controlled by the language file, as is the local naming of months. English month names are always supported.

Dates can be given in Gregorian or Julian calendar, set by the token "Jl" or "Gr" in the input. If neither is set, a default is chosen: inputs after October 15, 1582 (the time when the Gregorian calendar was first inaugurated in some parts of the world) are considered Gr, earlier inputs are considered Jl. In addition to Jl and Gr, we support "OS" (Old Style English dates that refer to the use of Julian calendar with a displaced change of year on March 24), JD (direct numerical input in Julian Day notation), and MJD (direct numerical input in Modified Julian Day notation as used in aviation and space flight).

The class does not support the input of negative year numbers but uses the markers "BC"/"BCE" and "AD"/"CE" instead. There is no year 0 in Gregorian or Julian calendars, but the class graciously considers this input to mean year 1 BC(E).

For prehisoric dates before 9999 BC(E) only year numbers are allowed (nothing else makes much sense). At this time, the years of Julian and Gregorian calendar still overlap significantly, so the transition to a purely solar annotation of prehistoric years is smooth. Technically, the class will consider prehistoric dates as Gregorian but very ancient times may be interpreted as desired (probably with reference to a physical notion of time that is not dependent on revolutions of earth around the sun).

Time formats

Times can be in formats like "23:12:45" and "12:30" possibly with additional modifiers "am" or "pm". Timezones are supported: the class knows many international timezone monikers (e.g. CET or GMT) and also allows time offsets directly after a time (e.g. "10:30-3:30" or "14:45:23+2"). Such offsets always refer to UTC. Timezones are only used on input and are not stored as part of the value.

Time offsets take leap years into account, e.g. the date "Feb 28 2004 23:00+2:00" is equivalent to "29 February 2004 01:00:00", while "Feb 28 1900 23:00+2:00" is equivalent to "1 March 1900 01:00:00".

Military time format is supported. This consists of 4 or 6 numeric digits followed by a one-letter timezone code (e.g. 1240Z is equivalent to 12:40 UTC).

I18N

Currently, neither keywords like "BCE", "Jl", or "pm", nor timezone monikers are internationalized. Timezone monikers may not require this, other than possibly for Cyrillic (added when needed). Month names are fully internationalized, but English names and abbreviations will also work in all languages. The class also supports ordinal day-of-month annotations like "st" and "rd", again only for English.

I18N includes the preferred order of dates, e.g. to interpret "5 6 2010".

Todo:: Theparsing process can encounter many kinds of well-defined problems but uses only one error message. More detailed reporting should be done.

Todo:: Try to reuse more of MediaWiki's records, e.g. to obtain month names or to format dates. The problem is that MW is based on SIO timestamps that don't extend to very ancient or future dates, and that MW uses PHP functions that are bound to UNIX time.

Author:

Markus Krötzsch

Fabian Howahl

Terry A. Hurlbut

Definition at line 97 of file SMW_DV_Time.php.

Member Function Documentation

SMWTimeValue::parseUserValue ( $ value ) [protected]

Initialise the datavalue from the given value string.

The format of this strings might be any acceptable user input and especially includes the output of getWikiValue().

Parameters:

string

$value

Reimplemented from SMWDataValue.

Definition at line 137 of file SMW_DV_Time.php.

References SMWDataValue::addError(), SMWDITime::CM_GREGORIAN, SMWDITime::newFromJD(), parseDateString(), SMWDITime::PREC_YMDT, and setDateFromParsedValues().

SMWTimeValue::parseDateString	(	$	string,
		&$	datecomponents,
		&$	calendarmodel,
		&$	era,
		&$	hours,
		&$	minutes,
		&$	seconds,
		&$	timeoffset
	)			`[protected]`

Parse the given string to check if it a date/time value.

The function sets the provided call-by-ref values to the respective values. If errors are encountered, they are added to the objects error list and false is returned. Otherwise, true is returned.

Parameters:

	$string	string input time representation, e.g. "12 May 2007 13:45:23-3:30"
	$datecomponents	array of strings that might belong to the specification of a date
	$calendarmodesl	string if model was set in input, otherwise false
	$era	string '+' or '-' if provided, otherwise false
	$hours	integer set to a value between 0 and 24
	$minutes	integer set to a value between 0 and 59
	$seconds	integer set to a value between 0 and 59, or false if not given
	$timeoffset	double set to a value for time offset (e.g. 3.5), or false if not given

Returns:: boolean stating if the parsing succeeded

Todo:: This method in principle allows date parsing to be internationalized further. Should be done.

Definition at line 206 of file SMW_DV_Time.php.

References SMWDataValue::addError(), and parseMonthString().

Referenced by parseUserValue().

static SMWTimeValue::parseTimeString	(	$	string,
		&$	hours,
		&$	minutes,
		&$	seconds,
		&$	timeoffset
	)			`[static]`

Parse the given string to check if it encodes an international time.

If successful, the function sets the provided call-by-ref values to the respective numbers and returns true. Otherwise, it returns false and does not set any values.

Note:: This method is only temporarily public for enabling SMWCompatibilityHelpers. Do not use it directly in your code.

Parameters:

	$string	string input time representation, e.g. "13:45:23-3:30"
	$hours	integer between 0 and 24
	$minutes	integer between 0 and 59
	$seconds	integer between 0 and 59, or false if not given
	$timeoffset	double for time offset (e.g. 3.5), or false if not given

Returns:: boolean stating if the parsing succeeded

Definition at line 309 of file SMW_DV_Time.php.

Referenced by SMWCompatibilityHelpers::dataItemFromDBKeys().

static SMWTimeValue::parseMilTimeString	(	$	string,
		&$	hours,
		&$	minutes,
		&$	seconds
	)			`[static, protected]`

Parse the given string to check if it encodes a "military time".

If successful, the function sets the provided call-by-ref values to the respective numbers and returns true. Otherwise, it returns false and does not set any values.

Parameters:

	$string	string input time representation, e.g. "134523"
	$hours	integer between 0 and 24
	$minutes	integer between 0 and 59
	$seconds	integer between 0 and 59, or false if not given

Returns:: boolean stating if the parsing succeeded

Definition at line 350 of file SMW_DV_Time.php.

static SMWTimeValue::parseMonthString	(	$	string,
		&$	monthname
	)			`[static, protected]`

Parse the given string to check if it refers to the string name ot abbreviation of a month name.

If yes, it is replaced by a normalized month name (placed in the call-by-ref parameter) and true is returned. Otherwise, false is returned and $monthname is not changed.

Parameters:

	$string	string month name or abbreviation to parse
	$monthname	string with standard 3-letter English month abbreviation

Returns:: boolean stating whether a month was found

Definition at line 377 of file SMW_DV_Time.php.

Referenced by parseDateString().

SMWTimeValue::interpretDateComponents	(	$	datecomponents,
		&$	date
	)			`[protected]`

Validate and interpret the date components as retrieved when parsing a user input.

The method takes care of guessing how a list of values such as "10 12 13" is to be interpreted using the current language settings. The result is stored in the call-by-ref parameter $date that uses keys 'y', 'm', 'd' and contains the respective numbers as values, or false if not specified. If errors occur, error messages are added to the objects list of errors, and false is returned. Otherwise, true is returned.

Parameters:

	$datecomponents	array of strings that might belong to the specification of a date
	$date	array set to result

Returns:: boolean stating if successful

Definition at line 409 of file SMW_DV_Time.php.

References SMWDataValue::addError(), and checkDateComponent().

Referenced by setDateFromParsedValues().

SMWTimeValue::setDateFromParsedValues	(	$	datecomponents,
		$	calendarmodel,
		$	era,
		$	hours,
		$	minutes,
		$	seconds,
		$	timeoffset
	)			`[protected]`

Initialise data from the provided intermediate results after parsing, assuming that a conventional date notation is used.

If errors occur, error messages are added to the objects list of errors, and false is returned. Otherwise, true is returned.

Parameters:

	$datecomponents	array of strings that might belong to the specification of a date
	$calendarmodesl	string if model was set in input, otherwise false
	$era	string '+' or '-' if provided, otherwise false
	$hours	integer value between 0 and 24
	$minutes	integer value between 0 and 59
	$seconds	integer value between 0 and 59, or false if not given
	$timeoffset	double value for time offset (e.g. 3.5), or false if not given

Returns:: boolean stating if successful

Definition at line 478 of file SMW_DV_Time.php.

References SMWDataValue::addError(), getCalendarModel(), interpretDateComponents(), SMWDITime::newFromJD(), and SMWDITime::PREC_Y.

Referenced by parseUserValue().

static SMWTimeValue::checkDateComponent	(	$	component,
		&$	numvalue
	)			`[static, protected]`

Check which roles a string component might play in a date, and set the call-by-ref parameter to the proper numerical representation.

The component string has already been normalized to be either a plain number, a month name, or a plain number with "d" pre-pended. The result is a bit vector to indicate the possible interpretations.

Parameters:

	$component	string
	$numvalue	integer representing the components value

Returns:: integer that encodes a three-digit bit vector

Definition at line 533 of file SMW_DV_Time.php.

Referenced by interpretDateComponents().

SMWTimeValue::getCalendarModel	(	$	presetmodel,
		$	year,
		$	month,
		$	day
	)			`[protected]`

Determine the calender model under which an input should be interpreted based on the given input data.

Parameters:

	$presetmodel	mixed string related to a user input calendar model (OS, Jl, Gr) or false
	$year	integer of the given year (adjusted for BC(E), i.e. possibly negative)
	$month	mixed integer of the month or false
	$day	mixed integer of the day or false

Returns:: integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN

Definition at line 573 of file SMW_DV_Time.php.

References SMWDITime::CM_GREGORIAN, and SMWDITime::CM_JULIAN.

Referenced by setDateFromParsedValues().

SMWTimeValue::loadDataItem ( SMWDataItem $ dataItem ) [protected]

See also:: SMWDataValue::loadDataItem()

Parameters:

$dataitem

SMWDataItem

Returns:: boolean

Reimplemented from SMWDataValue.

Definition at line 601 of file SMW_DV_Time.php.

References SMWDataItem::TYPE_TIME.

SMWTimeValue::getShortWikiText ( $ linked = NULL )

Returns a short textual representation for this data value.

If the value was initialised from a user supplied string, then this original string should be reflected in this short version (i.e. no normalisation should normally happen). There might, however, be additional parts such as code for generating tooltips. The output is in wiki text.

The parameter $linked controls linking of values such as titles and should be non-NULL and non-false if this is desired.

Reimplemented from SMWDataValue.

Definition at line 611 of file SMW_DV_Time.php.

References getPreferredCaption().

Referenced by getShortHTMLText().

SMWTimeValue::getShortHTMLText ( $ linker = NULL )

Returns a short textual representation for this data value.

If the value was initialised from a user supplied string, then this original string should be reflected in this short version (i.e. no normalisation should normally happen). There might, however, be additional parts such as code for generating tooltips. The output is in HTML text.

The parameter $linker controls linking of values such as titles and should be some Linker object (or NULL for no linking).

Reimplemented from SMWDataValue.

Definition at line 615 of file SMW_DV_Time.php.

References getShortWikiText().

SMWTimeValue::getLongWikiText ( $ linked = NULL )

Return the long textual description of the value, as printed for example in the factbox.

If errors occurred, return the error message The result always is a wiki-source string.

The parameter $linked controls linking of values such as titles and should be non-NULL and non-false if this is desired.

Reimplemented from SMWDataValue.

Definition at line 619 of file SMW_DV_Time.php.

References SMWDataValue::getErrorText(), getPreferredCaption(), and SMWDataValue::isValid().

Referenced by getLongHTMLText().

SMWTimeValue::getLongHTMLText ( $ linker = NULL )

Return the long textual description of the value, as printed for example in the factbox.

If errors occurred, return the error message The result always is an HTML string.

The parameter $linker controls linking of values such as titles and should be some Linker object (or NULL for no linking).

Reimplemented from SMWDataValue.

Definition at line 623 of file SMW_DV_Time.php.

References getLongWikiText().

SMWTimeValue::getWikiValue ( )

Todo:: The preferred caption may not be suitable as a wiki value (i.e. not parsable).

Reimplemented from SMWDataValue.

Definition at line 628 of file SMW_DV_Time.php.

References getPreferredCaption().

SMWTimeValue::isNumeric ( )

Convenience method that checks if the value that is used to sort data of this type is numeric.

This only works if the value is set.

Returns:: boolean

Reimplemented from SMWDataValue.

Definition at line 632 of file SMW_DV_Time.php.

SMWTimeValue::getYear ( $ calendarmodel = SMWDITime::CM_GREGORIAN )

Return the year number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

As everywhere in this class, there is no year 0.

Parameters:

$calendarmodel

integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN

Returns:: mixed typically a number but possibly false

Definition at line 644 of file SMW_DV_Time.php.

References getDataForCalendarModel().

Referenced by getCaptionFromDataitem(), getISO8601Date(), getMediaWikiDate(), and SRFiCalendar::parsedate().

SMWTimeValue::getMonth	(	$	calendarmodel = `SMWDITime::CM_GREGORIAN`,
		$	default = `1`
	)

Return the month number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

Parameters:

	$calendarmodel	integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN
	$default	value to return if month is not set at our level of precision

Returns:: mixed typically a number but possibly anything given as $default

Definition at line 661 of file SMW_DV_Time.php.

References getDataForCalendarModel(), and SMWDITime::PREC_YM.

Referenced by getCaptionFromDataitem(), getISO8601Date(), getMediaWikiDate(), and SRFiCalendar::parsedate().

SMWTimeValue::getDay	(	$	calendarmodel = `SMWDITime::CM_GREGORIAN`,
		$	default = `1`
	)

Return the day number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).

Parameters:

	$calendarmodel	integer either SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN
	$default	value to return if day is not set at our level of precision

Returns:: mixed typically a number but possibly anything given as $default

Definition at line 678 of file SMW_DV_Time.php.

References getDataForCalendarModel(), and SMWDITime::PREC_YMD.

Referenced by getISO8601Date(), getMediaWikiDate(), and SRFiCalendar::parsedate().

SMWTimeValue::getTimeString ( $ default = '00:00:00' )

Return the time as a string.

The time string has the format HH:MM:SS, without any timezone information (see class documentation for details on current timezone handling). The parameter $default optionally specifies the value returned if the date is valid but has no explicitly specified time. It can also be set to false to detect this situation.

Definition at line 695 of file SMW_DV_Time.php.

References SMWDITime::PREC_YMDT.

Referenced by getCaptionFromDataitem(), getISO8601Date(), and getMediaWikiDate().

SMWTimeValue::getXMLSchemaDate ( $ mindefault = true )

Deprecated:: This method is now called getISO8601Date(). It will vanish before SMW 1.7.

Definition at line 708 of file SMW_DV_Time.php.

References getISO8601Date().

SMWTimeValue::getISO8601Date ( $ mindefault = true )

Compute a string representation that largely follows the ISO8601 standard of representing dates.

Large year numbers may have more than 4 digits, which is not strictly conforming to the standard. The date includes year, month, and day regardless of the input precision, but will only include time when specified.

Conforming to the 2000 version of ISO8601, year 1 BC(E) is represented as "0000", year 2 BC(E) as "-0001" and so on.

Parameters:

$mindefault

boolean determining whether values below the precision of our input should be completed with minimal or maximal conceivable values

Returns:: string

Definition at line 727 of file SMW_DV_Time.php.

References SMWDITime::CM_GREGORIAN, getDay(), SMWDITime::getDayNumberForMonth(), getMonth(), getTimeString(), getYear(), SMWDITime::PREC_YMD, and SMWDITime::PREC_YMDT.

Referenced by getPreferredCaption(), and getXMLSchemaDate().

SMWTimeValue::getMediaWikiDate ( )

Use MediaWiki's date and time formatting.

It can't handle all inputs properly, but has superior i18n support.

Returns:: string

Definition at line 750 of file SMW_DV_Time.php.

References SMWDITime::CM_GREGORIAN, getDay(), getMonth(), getTimeString(), getYear(), SMWDITime::PREC_Y, and SMWDITime::PREC_YMD.

Referenced by getPreferredCaption().

SMWTimeValue::getDataForCalendarModel ( $ calendarmodel ) [protected]

Get the current data in the specified calendar model.

Conversion is not done for prehistoric dates (where it might lead to precision errors and produce results that are not meaningful). In this case, null might be returned if no data in the specified format is available.

Parameters:

$calendarmodel

integer one of SMWDITime::CM_GREGORIAN or SMWDITime::CM_JULIAN

Returns:: SMWDITime

Definition at line 784 of file SMW_DV_Time.php.

References SMWDITime::CM_GREGORIAN, and SMWDITime::CM_JULIAN.

Referenced by getDay(), getMonth(), getPreferredCaption(), and getYear().

SMWTimeValue::getCaptionFromDataitem ( SMWDITime $ dataitem )

Compute a suitable string to display the given date item.

Note:: MediaWiki's date functions are not applicable for the range of historic dates we support.

Since:: 1.6

Parameters:

SMWDITime

$dataitem

Returns:: string

Todo:: Internationalize the CE and BCE strings.

Definition at line 811 of file SMW_DV_Time.php.

References SMWDITime::getDay(), getMonth(), getTimeString(), getYear(), SMWDITime::PREC_YM, SMWDITime::PREC_YMD, and SMWDITime::PREC_YMDT.

Referenced by getPreferredCaption().

SMWTimeValue::getPreferredCaption ( ) [protected]

Compute a suitable string to display this date, taking into account the output format and the preferrable calendar models for the data.

Note:: MediaWiki's date functions are not applicable for the range of historic dates we support.

Returns:: string

Definition at line 838 of file SMW_DV_Time.php.

References SMWDITime::CM_GREGORIAN, SMWDITime::CM_JULIAN, getCaptionFromDataitem(), getDataForCalendarModel(), getISO8601Date(), and getMediaWikiDate().

Referenced by getLongWikiText(), getShortWikiText(), and getWikiValue().

Member Data Documentation

SMWTimeValue::$m_dataitem_greg = null [protected]

Definition at line 99 of file SMW_DV_Time.php.

SMWTimeValue::$m_dataitem_jul = null [protected]

Definition at line 100 of file SMW_DV_Time.php.

SMWTimeValue::$m_wikivalue [protected]

Definition at line 102 of file SMW_DV_Time.php.

SMWTimeValue::$m_months = array( 'January', 'February', 'March', 'April' , 'May' , 'June' , 'July' , 'August' , 'September' , 'October' , 'November' , 'December' ) [static, protected]

Definition at line 105 of file SMW_DV_Time.php.

SMWTimeValue::$m_monthsshort = array( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' ) [static, protected]

Definition at line 106 of file SMW_DV_Time.php.

SMWTimeValue::$m_formats = array( SMW_Y => array( 'y' ), SMW_YM => array( 'y', 'm' ), SMW_MY => array( 'm', 'y' ), SMW_YDM => array( 'y', 'd', 'm' ), SMW_YMD => array( 'y', 'm', 'd' ), SMW_DMY => array( 'd', 'm', 'y' ), SMW_MDY => array( 'm', 'd', 'y' ) ) [static, protected]

Definition at line 107 of file SMW_DV_Time.php.

SMWTimeValue::$m_tz [static, protected]

Initial value:

 array( 'A' => 1, 'ACDT' => 10.5, 'ACST' => 9.5, 'ADT' => -3, 'AEDT' => 11,
                'AEST' => 10, 'AKDT' => -8, 'AKST' => -9, 'AST' => -4, 'AWDT' => 9, 'AWST' => 8,
                'B' => 2, 'BST' => 1, 'C' => 3, 'CDT' => - 5, 'CEDT' => 2, 'CEST' => 2,
                'CET' => 1, 'CST' => -6, 'CXT' => 7, 'D' => 4, 'E' => 5, 'EDT' => - 4,
                'EEDT' => 3, 'EEST' => 3, 'EET' => 2, 'EST' => - 5, 'F' => 6, 'G' => 7,
                'GMT' => 0, 'H' => 8, 'HAA' => - 3, 'HAC' => - 5, 'HADT' => - 9, 'HAE' => -4,
                'HAP' => -7, 'HAR' => -6, 'HAST' => -10, 'HAT' => -2.5, 'HAY' => -8,
                'HNA' => -4, 'HNC' => -6, 'HNE' => -5, 'HNP' => -8, 'HNR' => -7, 'HNT' => -3.5,
                'HNY' => -9, 'I' => 9, 'IST' => 1, 'K' => 10, 'L' => 11, 'M' => 12,
                'MDT' => -6, 'MESZ' => 2, 'MEZ' => 1, 'MSD' => 4, 'MSK' => 3, 'MST' => -7,
                'N' => -1, 'NDT' => -2.5, 'NFT' => 11.5, 'NST' => -3.5, 'O' => -2, 'P' => -3 ,
                'PDT' => -7, 'PST' => -8, 'Q' => - 4, 'R' => - 5, 'S' => -6, 'T' => -7,
                'U' => -8, 'UTC' => 0, 'V' => - 9, 'W' => -10, 'WDT' => 9, 'WEDT' => 1,
                'WEST' => 1, 'WET' => 0, 'WST' => 8, 'X' => -11, 'Y' => -12, 'Z' => 0 )

General purpose time zone monikers and their associated offsets in hours and fractions of hours.

Definition at line 110 of file SMW_DV_Time.php.

SMWTimeValue::$m_miltz [static, protected]

Initial value:

 array( 'A' => 1, 'B' => 2, 'C' => 3, 'D' => 4, 'E' => 5, 'F' => 6,
                'G' => 7, 'H' => 8, 'I' => 9, 'K' => 10, 'L' => 11, 'M' => 12, 'N' => -1, 'O' => -2,
                'P' => -3, 'Q' => -4, 'R' => -5, 'S' => -6, 'T' => -7, 'U' => -8, 'V' => -9,
                'W' => -10, 'X' => -11, 'Y' => -12, 'Z' => 0 )

Military time zone monikers and their associated offsets in hours.

Definition at line 125 of file SMW_DV_Time.php.

const SMWTimeValue::J1582 = 2299160.5

Moment of switchover to Gregorian calendar.

Definition at line 131 of file SMW_DV_Time.php.

const SMWTimeValue::MJD_EPOCH = 2400000.5

Offset of Julian Days for Modified JD inputs.

Definition at line 133 of file SMW_DV_Time.php.

const SMWTimeValue::PREHISTORY = -10000

The year before which we do not accept anything but year numbers and largely discourage calendar models.

Definition at line 135 of file SMW_DV_Time.php.

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

SemanticMediaWiki/includes/datavalues/SMW_DV_Time.php


Public Member Functions
	getShortWikiText ($linked=NULL)
	Returns a short textual representation for this data value.
	getShortHTMLText ($linker=NULL)
	Returns a short textual representation for this data value.
	getLongWikiText ($linked=NULL)
	Return the long textual description of the value, as printed for example in the factbox.
	getLongHTMLText ($linker=NULL)
	Return the long textual description of the value, as printed for example in the factbox.
	getWikiValue ()
	isNumeric ()
	Convenience method that checks if the value that is used to sort data of this type is numeric.
	getYear ($calendarmodel=SMWDITime::CM_GREGORIAN)
	Return the year number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).
	getMonth ($calendarmodel=SMWDITime::CM_GREGORIAN, $default=1)
	Return the month number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).
	getDay ($calendarmodel=SMWDITime::CM_GREGORIAN, $default=1)
	Return the day number in the given calendar model, or false if this number is not available (typically when attempting to get prehistoric Julian calendar dates).
	getTimeString ($default= '00:00:00')
	Return the time as a string.
	getXMLSchemaDate ($mindefault=true)
	getISO8601Date ($mindefault=true)
	Compute a string representation that largely follows the ISO8601 standard of representing dates.
	getMediaWikiDate ()
	Use MediaWiki's date and time formatting.
	getCaptionFromDataitem (SMWDITime $dataitem)
	Compute a suitable string to display the given date item.
Static Public Member Functions
static	parseTimeString ($string, &$hours, &$minutes, &$seconds, &$timeoffset)
	Parse the given string to check if it encodes an international time.
Public Attributes
const	J1582 = 2299160.5
	Moment of switchover to Gregorian calendar.
const	MJD_EPOCH = 2400000.5
	Offset of Julian Days for Modified JD inputs.
const	PREHISTORY = -10000
	The year before which we do not accept anything but year numbers and largely discourage calendar models.
Protected Member Functions
	parseUserValue ($value)
	Initialise the datavalue from the given value string.
	parseDateString ($string, &$datecomponents, &$calendarmodel, &$era, &$hours, &$minutes, &$seconds, &$timeoffset)
	Parse the given string to check if it a date/time value.
	interpretDateComponents ($datecomponents, &$date)
	Validate and interpret the date components as retrieved when parsing a user input.
	setDateFromParsedValues ($datecomponents, $calendarmodel, $era, $hours, $minutes, $seconds, $timeoffset)
	Initialise data from the provided intermediate results after parsing, assuming that a conventional date notation is used.
	getCalendarModel ($presetmodel, $year, $month, $day)
	Determine the calender model under which an input should be interpreted based on the given input data.
	loadDataItem (SMWDataItem $dataItem)
	getDataForCalendarModel ($calendarmodel)
	Get the current data in the specified calendar model.
	getPreferredCaption ()
	Compute a suitable string to display this date, taking into account the output format and the preferrable calendar models for the data.
Static Protected Member Functions
static	parseMilTimeString ($string, &$hours, &$minutes, &$seconds)
	Parse the given string to check if it encodes a "military time".
static	parseMonthString ($string, &$monthname)
	Parse the given string to check if it refers to the string name ot abbreviation of a month name.
static	checkDateComponent ($component, &$numvalue)
	Check which roles a string component might play in a date, and set the call-by-ref parameter to the proper numerical representation.
Protected Attributes
	$m_dataitem_greg = null
	$m_dataitem_jul = null
	$m_wikivalue
Static Protected Attributes
static	$m_months = array( 'January', 'February', 'March', 'April' , 'May' , 'June' , 'July' , 'August' , 'September' , 'October' , 'November' , 'December' )
static	$m_monthsshort = array( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' )
static	$m_formats = array( SMW_Y => array( 'y' ), SMW_YM => array( 'y', 'm' ), SMW_MY => array( 'm', 'y' ), SMW_YDM => array( 'y', 'd', 'm' ), SMW_YMD => array( 'y', 'm', 'd' ), SMW_DMY => array( 'd', 'm', 'y' ), SMW_MDY => array( 'm', 'd', 'y' ) )
static	$m_tz
	General purpose time zone monikers and their associated offsets in hours and fractions of hours.
static	$m_miltz
	Military time zone monikers and their associated offsets in hours.

SMWTimeValue Class Reference [SMWDataValues]

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

SMWTimeValue Class Reference
[SMWDataValues]