Semantic MediaWiki and related extensions
Public Member Functions | Protected Member Functions | List of all members
SMW\FeedResultPrinter Class Reference
Collaboration diagram for SMW\FeedResultPrinter:
Collaboration graph
[legend]

Public Member Functions

 getName ()
 
 getMimeType (SMWQueryResult $queryResult)
 
 outputAsFile (SMWQueryResult $queryResult, array $params)
 
 getParamDefinitions (array $definitions)
 
 getDefaultSort ()
 
- Public Member Functions inherited from SMW\FileExportPrinter
 isExportFormat ()
 
 outputAsFile (SMWQueryResult $queryResult, array $params)
 
 getFileName (SMWQueryResult $queryResult)
 
 getQueryMode ($mode)
 
- Public Member Functions inherited from SMW\ResultPrinter
 __construct ($format, $inline=true, $useValidator=false)
 
 isEnabledFeature ($feature)
 
 getQueryMode ($context)
 
 getName ()
 
 setShowErrors ($show)
 
 getParameters ()
 
 getParamDefinitions (array $definitions)
 
 getNamedParameters (array $definitions=array())
 
 isExportFormat ()
 
 getDefaultSort ()
 
- Public Member Functions inherited from SMW\QueryResultPrinter
 getResult (QueryResult $results, array $fullParams, $outputMode)
 

Protected Member Functions

 getResultText (SMWQueryResult $res, $outputMode)
 
 feedTitle ()
 
 feedDescription ()
 
 feedURL ()
 
 getPageContent (WikiPage $wikiPage)
 
 feedItemDescription ($items, $pageContent)
 
 feedItemComments ()
 
- Protected Member Functions inherited from SMW\ResultPrinter
 getResultText (SMWQueryResult $res, $outputMode)
 
 buildResult (SMWQueryResult $results)
 
 handleParameters (array $params, $outputMode)
 
 postProcessParameters ()
 
 getLinker ($firstcol=false)
 
 getFurtherResultsLink (SMWQueryResult $res, $outputMode)
 
 getErrorString (SMWQueryResult $res)
 
 escapeText ($text, $outputmode)
 
 getSearchLabel ($outputmode)
 
 linkFurtherResults (SMWQueryResult $results)
 
 addError ($errorMessage)
 
 textDisplayParameters ()
 
 exportFormatParameters ()
 

Additional Inherited Members

- Static Public Attributes inherited from SMW\ResultPrinter
static $maxRecursionDepth = 2
 
- Protected Attributes inherited from SMW\ResultPrinter
 $m_params
 
 $params
 
 $fullParams
 
 $outputMode
 
 $results
 
 $mIntro = ''
 
 $mOutro = ''
 
 $mSearchlabel = null
 
 $mDefault = ''
 
 $mFormat
 
 $mLinkFirst
 
 $mLinkOthers
 
 $mShowHeaders = SMW_HEADERS_SHOW
 
 $mShowErrors = true
 
 $mInline
 
 $mLinker
 
 $mErrors = array()
 
 $isHTML = false
 
 $hasTemplates = false
 

Detailed Description

Result printer that exports query results as RSS/Atom feed

Since
1.8

GNU GPL v2 or later

Author
mwjames Result printer that exports query results as RSS/Atom feed

Member Function Documentation

SMW\FeedResultPrinter::feedDescription ( )
protected

Returns feed description

Since
1.8
Returns
string
SMW\FeedResultPrinter::feedItemComments ( )
protected

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

Since
1.8
Returns
string
SMW\FeedResultPrinter::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
SMW\FeedResultPrinter::feedTitle ( )
protected

Returns feed title

Since
1.8
Returns
string
SMW\FeedResultPrinter::feedURL ( )
protected

Returns feed URL

Since
1.8
Returns
string
SMW\FeedResultPrinter::getDefaultSort ( )
Since
2.5
Returns
string
SMW\FeedResultPrinter::getMimeType ( SMWQueryResult  $queryResult)
See also
SMWIExportPrinter::getMimeType
Since
1.8
Parameters
SMWQueryResult$queryResult
Returns
string

Implements SMW\ExportPrinter.

SMW\FeedResultPrinter::getName ( )

Returns human readable label for this printer

Returns
string

Implements SMW\QueryResultPrinter.

SMW\FeedResultPrinter::getPageContent ( WikiPage  $wikiPage)
protected

Returns page content

Since
1.8
Parameters
WikiPage$wikiPage
Returns
string
SMW\FeedResultPrinter::getParamDefinitions ( array  $definitions)
See also
SMWResultPrinter::getParamDefinitions
Since
1.8
Parameters
ParamDefinition[]$definitions
Returns
array

Implements SMW\QueryResultPrinter.

SMW\FeedResultPrinter::getResultText ( SMWQueryResult  $res,
  $outputMode 
)
protected

Returns a string that is to be sent to the caller

Parameters
SMWQueryResult$res
integer$outputMode
Returns
string
SMW\FeedResultPrinter::outputAsFile ( SMWQueryResult  $queryResult,
array  $params 
)
See also
SMWIExportPrinter::outputAsFile
Since
1.8
Parameters
SMWQueryResult$queryResult
array$params

Implements SMW\ExportPrinter.


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