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

Public Member Functions

 __construct (array &$results, array &$params, Filtered &$queryPrinter)
 
getQueryResults ()
 
getActualParameters ()
 
getQueryPrinter ()
 
 getResourceModules ()
 
 getResultText ()
 
 getJsDataForRow (ResultItem $row)
 
 getJsConfig ()
 
 getInitError ()
 

Static Public Member Functions

static getParameters ()
 

Detailed Description

The SRF_Filtered_View class.

Constructor & Destructor Documentation

◆ __construct()

SRF\Filtered\View\View::__construct ( array &  $results,
array &  $params,
Filtered $queryPrinter 
)

Constructor for the view.

Parameters
ResultItem[]$results
string[]$params array of parameter values given as key-value-pairs
Filtered$queryPrinter

Member Function Documentation

◆ getActualParameters()

& SRF\Filtered\View\View::getActualParameters ( )
Returns
string[]

◆ getInitError()

SRF\Filtered\View\View::getInitError ( )

Check if the view is ready to run, e.g. all required environment variables are set.

Returns
string | null

◆ getJsConfig()

SRF\Filtered\View\View::getJsConfig ( )

Returns an array of config data for this view to be stored in the JS

Returns
array

◆ getJsDataForRow()

SRF\Filtered\View\View::getJsDataForRow ( ResultItem  $row)
Parameters
ResultItem$row
Returns
null

◆ getParameters()

static SRF\Filtered\View\View::getParameters ( )
static

A function to describe the allowed parameters of a query for this view.

See also
DefaultConfig.php of param-processor/param-processor for allowed types
Returns
array of Parameter

◆ getQueryPrinter()

& SRF\Filtered\View\View::getQueryPrinter ( )
Returns
Filtered

◆ getQueryResults()

& SRF\Filtered\View\View::getQueryResults ( )
Returns
ResultItem[]

◆ getResourceModules()

SRF\Filtered\View\View::getResourceModules ( )

Returns the name (string) or names (array of strings) of the resource modules to load.

Returns
string|string[]|null

◆ getResultText()

SRF\Filtered\View\View::getResultText ( )

Returns the HTML text that is to be included for this view.

This text will appear on the page in a div that has the view's id set as class.

Returns
string

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

About | General disclaimer | Privacy policy