Inheritance diagram for SMW\Query\ResultPrinters\FeedExportPrinter:

Collaboration diagram for SMW\Query\ResultPrinters\FeedExportPrinter:

Public Member Functions
	getName ()

	isExportFormat ()

	disableHttpHeader ()

	getMimeType (QueryResult $queryResult)

	getFileName (QueryResult $queryResult)

	outputAsFile (QueryResult $queryResult, array $params)

	getQueryMode ( $mode)

	getParamDefinitions (array $definitions)

	getDefaultSort ()

Public Member Functions inherited from SMW\Query\ResultPrinters\ResultPrinter
	__construct ( $format, $inline=true)

	msg ()

	setRecursiveTextProcessor (RecursiveTextProcessor $recursiveTextProcessor)

	isEnabledFeature ( $feature)

	copyParser ()

	registerResources (array $modules=[], array $styleModules=[])

	getQueryMode ( $context)

	getName ()

	setShowErrors ( $show)

	getParameters ()

	getParamDefinitions (array $definitions)

	isExportFormat ()

	isDeferrable ()

	supportsRecursiveAnnotation ()

	getDefaultSort ()

Public Member Functions inherited from SMW\Query\ResultPrinter
	getResult (QueryResult $results, array $fullParams, $outputMode)

Protected Member Functions
	getResultText (QueryResult $res, $outputMode)

	feedTitle ()

	feedDescription ()

	feedURL ()

	getPageContent (WikiPage $wikiPage)

	feedItemDescription ( $items, $pageContent)

	feedItemComments ()

Protected Member Functions inherited from SMW\Query\ResultPrinters\ResultPrinter
	getResultText (QueryResult $res, $outputMode)

	buildResult (QueryResult $results)

	handleNonFileResult ( $result, QueryResult $results, $outputmode)

	handleParameters (array $params, $outputMode)

	postProcessParameters ()

	getLinker ( $firstcol=false)

	getLink (QueryResult $res, $outputMode, $classAffix='')

	getFurtherResultsLink (QueryResult $res, $outputMode)

	getErrorString (QueryResult $res)

	getResources ()

	escapeText ( $text, $outputmode)

	getSearchLabel ( $outputmode)

	linkFurtherResults (QueryResult $results)

	addError ( $errorMessage)

Additional Inherited Members
Public Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
const	DEFERRED_DATA = 'deferred.data'

Static Public Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
static	$maxRecursionDepth = 2

Protected Attributes inherited from SMW\Query\ResultPrinters\ResultPrinter
	$params

	$fullParams

	$outputMode

	$results

	$mIntro = ''

	$mOutro = ''

	$mSearchlabel = null

	$mDefault = ''

	$mFormat

	$mLinkFirst

	$mLinkOthers

	$mShowHeaders = SMW_HEADERS_SHOW

	$mShowErrors = true

	$mInline

	$mLinker

	$mErrors = []

	$isHTML = false

	$hasTemplates = false

	$recursiveTextProcessor

	$transcludeAnnotation = true

Detailed Description

Result printer that exports query results as RSS/Atom feed

Since: 1.8

GNU GPL v2 or later

Author: mwjames

Member Function Documentation

◆ disableHttpHeader()

SMW\Query\ResultPrinters\FeedExportPrinter::disableHttpHeader ( )

See also: 3.0

◆ feedDescription()

SMW\Query\ResultPrinters\FeedExportPrinter::feedDescription ( )

protected

Returns feed description

Since: 1.8

Returns: string

◆ feedItemComments()

SMW\Query\ResultPrinters\FeedExportPrinter::feedItemComments ( )

protected

According to MW documentation, the comment field is only implemented for RSS

Since: 1.8

Returns: string

◆ feedItemDescription()

SMW\Query\ResultPrinters\FeedExportPrinter::feedItemDescription	(	$items,
		$pageContent
	)

protected

Feed item description and property value output manipulation

Note: FeedItem will do an FeedItem::xmlEncode therefore no need to be overly cautious here

Since: 1.8

Parameters

array	$items
string	$pageContent

Returns: string

◆ feedTitle()

SMW\Query\ResultPrinters\FeedExportPrinter::feedTitle ( )

protected

Returns feed title

Since: 1.8

Returns: string

◆ feedURL()

SMW\Query\ResultPrinters\FeedExportPrinter::feedURL ( )

protected

Returns feed URL

Since: 1.8

Returns: string

◆ getDefaultSort()

SMW\Query\ResultPrinters\FeedExportPrinter::getDefaultSort ( )

Since: 2.5

See also: ResultPrinter::getDefaultSort

◆ getFileName()

SMW\Query\ResultPrinters\FeedExportPrinter::getFileName ( QueryResult $queryResult )

See also: ExportPrinter::getFileName

Some printers can produce not only embeddable HTML or Wikitext, but can also produce stand-alone files. An example is RSS or iCalendar. This function returns a filename that is to be sent to the caller in such a case (the default filename is created by browsers from the URL, and it is often not pretty).

Parameters

QueryResult $queryResult

Returns: string|boolean

Implements SMW\Query\ExportPrinter.

◆ getMimeType()

SMW\Query\ResultPrinters\FeedExportPrinter::getMimeType ( QueryResult $queryResult )

See also: ExportPrinter::getMimeType

Some printers do not mainly produce embeddable HTML or Wikitext, but produce stand-alone files. An example is RSS or iCalendar. This function returns the mimetype string that this file would have, or FALSE if no standalone files are produced.If this function returns something other than FALSE, then the printer will not be regarded as a printer that displays in-line results. This is used to determine if a file output should be generated in Special:Ask.

Since: 1.8

Parameters

QueryResult $queryResult

Returns: string

Implements SMW\Query\ExportPrinter.

◆ getName()

SMW\Query\ResultPrinters\FeedExportPrinter::getName ( )

See also: ResultPrinter::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

Implements SMW\Query\ResultPrinter.

◆ getPageContent()

SMW\Query\ResultPrinters\FeedExportPrinter::getPageContent ( WikiPage $wikiPage )

protected

Returns page content

Since: 1.8

Parameters

WikiPage $wikiPage

Returns: string

◆ getParamDefinitions()

SMW\Query\ResultPrinters\FeedExportPrinter::getParamDefinitions ( array $definitions )

See also: ResultPrinter::getParamDefinitions

Takes a list of parameter definitions and adds those supported by this result printer. Most result printers should override this method.

Since: 1.8

Parameters

ParamDefinition[] $definitions

Returns: array

Implements SMW\Query\ResultPrinter.

◆ getQueryMode()

SMW\Query\ResultPrinters\FeedExportPrinter::getQueryMode ( $mode )

The export uses MODE_INSTANCES on special pages (so that instances are retrieved for the export) otherwise use MODE_NONE (displaying just a download link).

Parameters

$mode

Returns: integer

Implements SMW\Query\ResultPrinter.

◆ getResultText()

SMW\Query\ResultPrinters\FeedExportPrinter::getResultText	(	QueryResult	$res,
			$outputMode
	)

protected

Returns a string that is to be sent to the caller

Parameters

QueryResult	$res
integer	$outputMode

Returns: string

◆ isExportFormat()

SMW\Query\ResultPrinters\FeedExportPrinter::isExportFormat ( )

See also: ExportPrinter::isExportFormat

Returns if the format is an export format.

Since: 1.8

Returns: boolean

Implements SMW\Query\ResultPrinter.

◆ outputAsFile()

SMW\Query\ResultPrinters\FeedExportPrinter::outputAsFile	(	QueryResult	$queryResult,
		array	$params
	)

See also: ExportPrinter::outputAsFile

Outputs the result as file.

Since: 1.8

Parameters

QueryResult	$queryResult
array	$params

Implements SMW\Query\ExportPrinter.

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

FeedExportPrinter.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ disableHttpHeader()

◆ feedDescription()

◆ feedItemComments()

◆ feedItemDescription()

◆ feedTitle()

◆ feedURL()

◆ getDefaultSort()

◆ getFileName()

◆ getMimeType()

◆ getName()

◆ getPageContent()

◆ getParamDefinitions()

◆ getQueryMode()

◆ getResultText()

◆ isExportFormat()

◆ outputAsFile()