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

Public Member Functions

 getName ()
 
 getMimeType (QueryResult $queryResult)
 
 getFileName (QueryResult $queryResult)
 
 getParamDefinitions (array $definitions)
 
 getFormattedList ( $key, array $values)
 
- 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)
 
 getMimeType (QueryResult $queryResult)
 
 getFileName (QueryResult $queryResult)
 

Protected Member Functions

 getResultText (QueryResult $res, $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

Printer class for creating BibTeX exports

For details on availble keys see the README

Example of a book :

{abramowitz1964homf, author = "Milton Abramowitz and Irene A. Stegun", title = "Handbook of Mathematical Functions", publisher = "Dover", year = 1964, address = "New York", edition = "ninth Dover printing, tenth GPO printing" }

GNU GPL v2+

Since
1.5
Author
Markus Krötzsch
Denny Vrandecic
Frank Dengler
Steren Giannini

Member Function Documentation

◆ getFileName()

SRF\BibTex\BibTexFileExportPrinter::getFileName ( QueryResult  $queryResult)

◆ getFormattedList()

SRF\BibTex\BibTexFileExportPrinter::getFormattedList (   $key,
array  $values 
)
Since
3.1
Parameters
array$list
Returns
string

◆ getMimeType()

SRF\BibTex\BibTexFileExportPrinter::getMimeType ( QueryResult  $queryResult)

◆ getName()

SRF\BibTex\BibTexFileExportPrinter::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()

SRF\BibTex\BibTexFileExportPrinter::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()

SRF\BibTex\BibTexFileExportPrinter::getResultText ( QueryResult  $res,
  $outputMode 
)
protected
See also
ResultPrinter::getResultText

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

About | General disclaimer | Privacy policy