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

Public Member Functions

 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

 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

Base class for file export result printers

Since
1.8 GNU GPL v2+
Author
Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Member Function Documentation

◆ disableHttpHeader()

SMW\Query\ResultPrinters\FileExportPrinter::disableHttpHeader ( )
See also
3.0

◆ getFileName()

SMW\Query\ResultPrinters\FileExportPrinter::getFileName ( SMWQueryResult  $queryResult)
See also
ExportPrinter::getFileName
Since
1.8
Parameters
SMWQueryResult$queryResult
Returns
string|boolean

◆ getFileResult()

SMW\Query\ResultPrinters\FileExportPrinter::getFileResult (   $queryResult,
  $params 
)
protected

ResultPrinter::getResult is marked as final making any attempt to test this method futile hence we isolate its access to ensure to be able to verify the access sequence (#4375).

◆ getQueryMode()

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

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

Parameters
$mode
Returns
integer

Implements SMW\Query\ResultPrinter.

◆ isExportFormat()

SMW\Query\ResultPrinters\FileExportPrinter::isExportFormat ( )
See also
ExportPrinter::isExportFormat
Since
1.8
Returns
boolean

Implements SMW\Query\ResultPrinter.

◆ outputAsFile()

SMW\Query\ResultPrinters\FileExportPrinter::outputAsFile ( SMWQueryResult  $queryResult,
array  $params 
)
See also
ExportPrinter::outputAsFile
Since
1.8
Parameters
SMWQueryResult$queryResult
array$params

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

About | General disclaimer | Privacy policy