SRFBibTeX Class Reference
[SemanticResultFormats]

Printer class for creating BibTeX exports. More...

Inherits SMWResultPrinter.

List of all members.

Public Member Functions

 getMimeType ($res)
 Some printers do not mainly produce embeddable HTML or Wikitext, but produce stand-alone files.
 getFileName ($res)
 Some printers can produce not only embeddable HTML or Wikitext, but can also produce stand-alone files.
 getQueryMode ($context)
 This function determines the query mode that is to be used for this printer in various contexts.
 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

 getResultText (SMWQueryResult $res, $outputmode)
 Return serialised results in specified format.
 getItemForResultRow (array $row)
 Gets a SMWBibTeXEntry for the row.

Protected Attributes

 $m_title = ''
 $m_description = ''


Detailed Description

Printer class for creating BibTeX exports.

Author:
Markus Krötzsch

Denny Vrandecic

Frank Dengler

Steren Giannini

Definition at line 32 of file SRF_BibTeX.php.


Member Function Documentation

SRFBibTeX::getMimeType ( res  ) 

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.

Reimplemented from SMWResultPrinter.

Definition at line 36 of file SRF_BibTeX.php.

SRFBibTeX::getFileName ( res  ) 

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).

See also SMWResultPrinter::getMimeType()

Reimplemented from SMWResultPrinter.

Definition at line 40 of file SRF_BibTeX.php.

References SMWResultPrinter::getSearchLabel().

SRFBibTeX::getQueryMode ( context  ) 

This function determines the query mode that is to be used for this printer in various contexts.

The query mode influences how queries to that printer should be processed to obtain a result. Possible values are SMWQuery::MODE_INSTANCES (retrieve instances), SMWQuery::MODE_NONE (do nothing), SMWQuery::MODE_COUNT (get number of results), SMWQuery::MODE_DEBUG (return debugging text). Possible values for context are SMWQueryProcessor::SPECIAL_PAGE, SMWQueryProcessor::INLINE_QUERY, SMWQueryProcessor::CONCEPT_DESC.

The default implementation always returns SMWQuery::MODE_INSTANCES. File exports like RSS will use MODE_INSTANCES on special pages (so that instances are retrieved for the export) and MODE_NONE otherwise (displaying just a download link).

Reimplemented from SMWResultPrinter.

Definition at line 48 of file SRF_BibTeX.php.

References SMWQuery::MODE_INSTANCES, SMWQuery::MODE_NONE, and SMWQueryProcessor::SPECIAL_PAGE.

SRFBibTeX::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 52 of file SRF_BibTeX.php.

SRFBibTeX::getResultText ( SMWQueryResult res,
outputmode 
) [protected]

Return serialised results in specified format.

Implemented by subclasses.

Reimplemented from SMWResultPrinter.

Definition at line 56 of file SRF_BibTeX.php.

References getItemForResultRow(), SMWQueryResult::getQueryLink(), and SMWResultPrinter::getSearchLabel().

SRFBibTeX::getItemForResultRow ( array $  row  )  [protected]

Gets a SMWBibTeXEntry for the row.

Since:
1.6
Parameters:
array of SMWResultArray $row
Returns:
SMWBibTeXEntry

Definition at line 102 of file SRF_BibTeX.php.

Referenced by getResultText().

SRFBibTeX::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 205 of file SRF_BibTeX.php.

References SMWResultPrinter::exportFormatParameters().


Member Data Documentation

SRFBibTeX::$m_title = '' [protected]

Definition at line 33 of file SRF_BibTeX.php.

SRFBibTeX::$m_description = '' [protected]

Definition at line 34 of file SRF_BibTeX.php.


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

Generated on Sun Mar 18 07:15:45 2012 for Semantic MediaWiki by  doxygen 1.5.6