SMWEmbeddedResultPrinter Class Reference
[SMWQuery]

Printer for embedded data. More...

Inherits SMWResultPrinter.

List of all members.

Public Member Functions
	getName ()
	Get a human readable label for this printer.
	getParameters ()
	A function to describe the allowed parameters of a query using any specific format - most query printers should override this function.
Protected Member Functions
	handleParameters (array $params, $outputmode)
	getResultText (SMWQueryResult $res, $outputmode)
	Return serialised results in specified format.
Protected Attributes
	$m_showhead
	$m_embedformat

---

Detailed Description

Printer for embedded data.

Embeds in the page output the contents of the pages in the query result set. Printouts are ignored: it only matters which pages were returned by the query. The optional "titlestyle" formatting parameter can be used to apply a format to the headings for the page titles. If "titlestyle" is not specified, a

tag is used. Fernando Correia Markus Krötzsch

Definition at line 20 of file SMW_QP_Embedded.php.

---

Member Function Documentation

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

See also:

SMWResultPrinter::handleParameters

Since:

1.7

Parameters:

	array	$params
	$outputmode

Reimplemented from SMWResultPrinter.

Definition at line 33 of file SMW_QP_Embedded.php.

SMWEmbeddedResultPrinter::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 40 of file SMW_QP_Embedded.php.

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

Return serialised results in specified format.

Implemented by subclasses.

Reimplemented from SMWResultPrinter.

Definition at line 44 of file SMW_QP_Embedded.php.

References $wgTitle, SMWQueryResult::getQueryLink(), SMWResultPrinter::getSearchLabel(), SMWResultPrinter::linkFurtherResults(), and SMWDataValueFactory::newDataItemValue().

SMWEmbeddedResultPrinter::getParameters

(

)

A function to describe the allowed parameters of a query using any specific format - most query printers should override this function.

TODO: refactor non-printer params up to the query processor and do all param handling there.

Since:

1.5

Returns:

array of Parameter

Reimplemented from SMWResultPrinter.

Definition at line 121 of file SMW_QP_Embedded.php.

References SMWResultPrinter::$params.

---

Member Data Documentation

SMWEmbeddedResultPrinter::$m_showhead [protected]

Definition at line 22 of file SMW_QP_Embedded.php.

SMWEmbeddedResultPrinter::$m_embedformat [protected]

Definition at line 23 of file SMW_QP_Embedded.php.

---

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

• SemanticMediaWiki/includes/queryprinters/SMW_QP_Embedded.php