SRF\Filtered\Filter\Filter Class Reference

Inheritance diagram for SRF\Filtered\Filter\Filter:

Public Member Functions
	__construct (array &$results, SMWPrintRequest $printRequest, Filtered &$queryPrinter)
&	getQueryResults ()
&	getPrintRequest ()
&	getQueryPrinter ()
	getActualParameters ()
	getResourceModules ()
	getResultText ()
	getJsDataForRow (ResultItem $row)
	isValidFilterForPropertyType ()
	getJsConfig ()

Protected Member Functions
	buildJsConfig ()
	addValueToJsConfig ( $paramName, $configName, $default=null, $callback=null)
	addValueListToJsConfig ( $paramName, $configName, $default=null, $callback=null)

Detailed Description

The SRF_Filtered_Filter class.

Constructor & Destructor Documentation

__construct()

SRF\Filtered\Filter\Filter::__construct	(	array &	$results,
		SMWPrintRequest	$printRequest,
		Filtered &	$queryPrinter
	)

Filter constructor.

Parameters

	ResultItem[]	$results
SMWPrintRequest	$printRequest
Filtered	$queryPrinter

Member Function Documentation

addValueListToJsConfig()

SRF\Filtered\Filter\Filter::addValueListToJsConfig (   $paramName,   $configName,   $default = null,   $callback = null  )

protected

Parameters

	$paramName
	$configName
null	$default

addValueToJsConfig()

SRF\Filtered\Filter\Filter::addValueToJsConfig (   $paramName,   $configName,   $default = null,   $callback = null  )

protected

Parameters

string	$paramName
string	$configName
mixed  |  null	$default
callable  |  null	$callback

getActualParameters()

SRF\Filtered\Filter\Filter::getActualParameters

(

)

Returns

string[]

getJsConfig()

SRF\Filtered\Filter\Filter::getJsConfig

(

)

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

Returns

string[]

getJsDataForRow()

SRF\Filtered\Filter\Filter::getJsDataForRow

(

ResultItem

$row

)

Parameters

ResultItem

$row

Returns

null | string

getPrintRequest()

& SRF\Filtered\Filter\Filter::getPrintRequest

(

)

Returns

SMWPrintRequest

getQueryPrinter()

& SRF\Filtered\Filter\Filter::getQueryPrinter

(

)

Returns

Filtered

getQueryResults()

& SRF\Filtered\Filter\Filter::getQueryResults

(

)

Returns

ResultItem[]

getResourceModules()

SRF\Filtered\Filter\Filter::getResourceModules

(

)

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

Returns

string|string[]

getResultText()

SRF\Filtered\Filter\Filter::getResultText

(

)

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

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

Returns

string

isValidFilterForPropertyType()

SRF\Filtered\Filter\Filter::isValidFilterForPropertyType

(

)

Returns

bool

---

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

• Filter.php