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

Protected Member Functions

 getHtml (array $data)
 
 addResources ($resource)
 
 getId ()
 
 createLoadingHtmlPlaceholder ()
 
 loading ()
 
 encodeToJsonForId ($id, $data)
 
 encode ($id, $data)
 
 getResultText (SMWQueryResult $queryResult, $outputMode)
 
- 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

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

Base class for result printers that use the serialized results

Since
1.9

GNU GPL v2 or later

Author
mwjames

Member Function Documentation

SMW\RawResultPrinter::addResources (   $resource)
protected

Convenience method to register resources

Since
1.9
Parameters
string$resource
SMW\RawResultPrinter::createLoadingHtmlPlaceholder ( )
protected

Convenience method generating a visual placeholder before any JS is registered to indicate that resources (JavaScript, CSS) are being loaded and once ready ensure to set ( '.smw-spinner' ).hide()

Since
1.9
SMW\RawResultPrinter::encode (   $id,
  $data 
)
protected
Deprecated:
since 2.0
SMW\RawResultPrinter::encodeToJsonForId (   $id,
  $data 
)
protected

Convenience method to encode output data

Since
1.9
Parameters
string$id
array$data
SMW\RawResultPrinter::getHtml ( array  $data)
abstractprotected

Returns html output.

Since
1.9
SMW\RawResultPrinter::getId ( )
protected

Convenience method to create a unique id

Since
1.9
SMW\RawResultPrinter::getResultText ( SMWQueryResult  $queryResult,
  $outputMode 
)
protected

Returns serialised content

See also
SMWResultPrinter::getResultText()
Parameters
SMWQueryResult$queryResult
$outputMode
Returns
string
SMW\RawResultPrinter::loading ( )
protected
Deprecated:
since 2.0

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