SRFTimeline Class Reference
[SemanticResultFormats]

Result printer for timeline data. More...

Inherits SMWResultPrinter.

List of all members.

Public Member Functions
	getName ()
	Get a human readable label for this printer.
	getParameters ()
Protected Member Functions
	handleParameters (array $params, $outputmode)
	getResultText (SMWQueryResult $res, $outputmode)
	Return serialised results in specified format.
	includeJS ()
	Includes the JavaScript required for the timeline and eventline formats.
	getEventsHTML (SMWQueryResult $res, $outputmode, $isEventline)
	Returns the HTML for the events.
	handlePropertyValue (SMWDataValue $object, $outputmode, SMWPrintRequest $pr, $first_col, &$hastitle, &$hastime, $first_value, $isEventline, &$curmeta, &$curdata, $date_value, &$output, array &$positions)
	Hanldes a single property value.
Protected Attributes
	$m_tlstart = ''
	$m_tlend = ''
	$m_tlsize = ''
	$m_tlbands = ''
	$m_tlpos = ''

---

Detailed Description

Result printer for timeline data.

Definition at line 17 of file SRF_Timeline.php.

---

Member Function Documentation

SRFTimeline::handleParameters	(	array $	params,
		$	outputmode
	)			[protected]

See also:

SMWResultPrinter::handleParameters

Since:

1.6.3

Parameters:

	array	$params
	$outputmode

Reimplemented from SMWResultPrinter.

Definition at line 33 of file SRF_Timeline.php.

References smwfNormalTitleDBKey().

SRFTimeline::getName

(

)

Get a human readable label for this printer.

The default is to return just the format identifier. Concrete implementations may refer to messages here. The format name is normally not used in wiki text but only in forms etc. hence the user language should be used when retrieving messages.

Returns:

string

Reimplemented from SMWResultPrinter.

Definition at line 46 of file SRF_Timeline.php.

SRFTimeline::getResultText	(	SMWQueryResult $	res,
		$	outputmode
	)			[protected]

Return serialised results in specified format.

Implemented by subclasses.

Reimplemented from SMWResultPrinter.

Definition at line 50 of file SRF_Timeline.php.

References getEventsHTML(), SMWQueryResult::getQueryLink(), includeJS(), and SMWPrintRequest::PRINT_PROP.

SRFTimeline::includeJS

(

)

[protected]

Includes the JavaScript required for the timeline and eventline formats.

Since:

1.5.3

Definition at line 104 of file SRF_Timeline.php.

References $srfgScriptPath, SMWOutputs::requireHeadItem(), and SMWOutputs::requireResource().

Referenced by getResultText().

SRFTimeline::getEventsHTML	(	SMWQueryResult $	res,
		$	outputmode,
		$	isEventline
	)			[protected]

Returns the HTML for the events.

Since:

1.5.3

Parameters:

	SMWQueryResult	$res
	$outputmode
	boolean	$isEventline

Returns:

string

Definition at line 138 of file SRF_Timeline.php.

References handlePropertyValue().

Referenced by getResultText().

SRFTimeline::handlePropertyValue	(	SMWDataValue $	object,
		$	outputmode,
		SMWPrintRequest $	pr,
		$	first_col,
		&$	hastitle,
		&$	hastime,
		$	first_value,
		$	isEventline,
		&$	curmeta,
		&$	curdata,
		$	date_value,
		&$	output,
		array &$	positions
	)			[protected]

Hanldes a single property value.

Returns an array with data for a single event or false.

FIXME: 13 arguments, of which a whole bunch are byref... not a good design :)

Since:

1.5.3

Parameters:

	SMWDataValue	$object
	$outputmode
	SMWPrintRequest	$pr
	boolean	$first_col
	boolean	&$hastitle
	boolean	&$hastime
	boolean	$first_value
	boolean	$isEventline
	string	&$curmeta
	string	&$curdata
	&$date_value
	boolean	&$output
	array	&$positions

Returns:

false or array

Definition at line 259 of file SRF_Timeline.php.

References SMWDataValue::getHash(), SMWResultPrinter::getLinker(), SMWDataValue::getLongText(), SMWDataValue::getShortText(), SMWPrintRequest::getText(), SMWPrintRequest::PRINT_PROP, and SMWPrintRequest::PRINT_THIS.

Referenced by getEventsHTML().

SRFTimeline::getParameters

(

)

See also:

SMWResultPrinter::getParameters

Since:

1.5.0

Returns:

array

Reimplemented from SMWResultPrinter.

Definition at line 358 of file SRF_Timeline.php.

References SMWResultPrinter::$params.

---

Member Data Documentation

SRFTimeline::$m_tlstart = '' [protected]

Definition at line 19 of file SRF_Timeline.php.

SRFTimeline::$m_tlend = '' [protected]

Definition at line 20 of file SRF_Timeline.php.

SRFTimeline::$m_tlsize = '' [protected]

Definition at line 21 of file SRF_Timeline.php.

SRFTimeline::$m_tlbands = '' [protected]

Definition at line 22 of file SRF_Timeline.php.

SRFTimeline::$m_tlpos = '' [protected]

Definition at line 23 of file SRF_Timeline.php.

---

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

• SemanticResultFormats/Timeline/SRF_Timeline.php