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

Public Member Functions

 getArrayFromValueList ( $valueList, $delimiter=',')
 
 getParser ()
 
 setParser ( $parser)
 
 getPrintrequests ()
 
 hasTemplates ( $hasTemplates=null)
 
 getName ()
 
 getParamDefinitions (array $definitions)
 
 getLinker ( $firstcol=false, $force=false)
 
 uniqid ( $id=null)
 
 addError ( $errorMessage)
 
- 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)
 

Protected Member Functions

 handleParameters (array $params, $outputMode)
 
 registerResourceModules ( $resourceModules)
 
 getResultsForJs ( $result)
 
- 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 that displays results in switchable views and offers client-side (JavaScript based) filtering.

This result printer is ultimately planned to replace exhibit. Currently only a list view is available. It is not yet possible to switch between views. There is also only the 'value' filter available yet.

Syntax of the #ask call: (This is only a syntax example. For currently available features see the documentation of the various classes.)

{{#ask:[[SomeCondition]] |? SomePrintout |+filter=value, someFutureFilter |+value filter switches=and or, disable, all, none |+someFutureFilter filter option=someOptionValue |? SomeOtherPrintout |+filter=value, someOtherFutureFilter |+someOtherFutureFilter filter option=someOptionValue

|format=filtered |views=list, someFutureView, someOtherFutureView

|list view type=list |list view template=ListItem

|someFutureView view option=someOptionValue

|someOtherFutureView view option=someOptionValue

}}

All format specific parameters are optional, although leaving the 'views' parameter empty probably does not make much sense.

Member Function Documentation

◆ getArrayFromValueList()

SRF\Filtered\Filtered::getArrayFromValueList (   $valueList,
  $delimiter = ',' 
)
Parameters
string$valueList
string$delimiter
Returns
string[]

◆ getName()

SRF\Filtered\Filtered::getName ( )

Get a human readable label for this printer.

Returns
string

Implements SMW\Query\ResultPrinter.

◆ getParamDefinitions()

SRF\Filtered\Filtered::getParamDefinitions ( array  $definitions)
See also
SMWResultPrinter::getParamDefinitions
DefaultConfig.php of param-processor/param-processor for allowed types
Since
1.8
Parameters
$definitionsarray of IParamDefinition
Returns
array of IParamDefinition|array

Implements SMW\Query\ResultPrinter.

◆ getParser()

SRF\Filtered\Filtered::getParser ( )
Returns
| | null

◆ getPrintrequests()

SRF\Filtered\Filtered::getPrintrequests ( )
Returns
mixed

◆ getResultsForJs()

SRF\Filtered\Filtered::getResultsForJs (   $result)
protected
Parameters
ResultItem[]$result
Returns
array

◆ handleParameters()

SRF\Filtered\Filtered::handleParameters ( array  $params,
  $outputMode 
)
protected

Does any additional parameter handling that needs to be done before the actual result is build.

Parameters
array$params
$outputMode

◆ registerResourceModules()

SRF\Filtered\Filtered::registerResourceModules (   $resourceModules)
protected
Parameters
string| string[] | null $resourceModules

◆ setParser()

SRF\Filtered\Filtered::setParser (   $parser)
Parameters
\Parser  |  \StubObject$parser

◆ uniqid()

SRF\Filtered\Filtered::uniqid (   $id = null)
Parameters
string | null$id
Returns
string

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

About | General disclaimer | Privacy policy