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

Public Member Functions

 getName ()
 
 getMimeType (QueryResult $queryResult)
 
 getFileName (QueryResult $queryResult)
 
 getParamDefinitions (array $definitions)
 
- Public Member Functions inherited from SMW\Query\ResultPrinters\FileExportPrinter
 isExportFormat ()
 
 disableHttpHeader ()
 
 outputAsFile (SMWQueryResult $queryResult, array $params)
 
 getFileName (SMWQueryResult $queryResult)
 
 getQueryMode ( $mode)
 
- 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)
 
- Public Member Functions inherited from SMW\Query\ExportPrinter
 outputAsFile (QueryResult $queryResult, array $params)
 

Protected Member Functions

 getResultText (QueryResult $queryResult, $outputMode)
 
- Protected Member Functions inherited from SMW\Query\ResultPrinters\FileExportPrinter
 getFileResult ( $queryResult, $params)
 
- 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 to print results in UNIX-style DSV (deliminter separated value) format.

GNU GPL v2+

Since
1.6
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

◆ getFileName()

SMW\Query\ResultPrinters\DsvResultPrinter::getFileName ( QueryResult  $queryResult)
See also
FileExportPrinter::getMimeType
Since
1.8

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\DsvResultPrinter::getMimeType ( QueryResult  $queryResult)
See also
FileExportPrinter::getMimeType
Since
1.8

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\DsvResultPrinter::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.

◆ getParamDefinitions()

SMW\Query\ResultPrinters\DsvResultPrinter::getParamDefinitions ( array  $definitions)
See also
ResultPrinter::getParamDefinitions
Since
1.8

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.

◆ getResultText()

SMW\Query\ResultPrinters\DsvResultPrinter::getResultText ( QueryResult  $queryResult,
  $outputMode 
)
protected

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

About | General disclaimer | Privacy policy