SMW\ParserFunctions\AskParserFunction Class Reference

Public Member Functions
	__construct (ParserData $parserData, MessageFormatter $messageFormatter, CircularReferenceGuard $circularReferenceGuard, ExpensiveFuncExecutionWatcher $expensiveFuncExecutionWatcher)
	setPostProcHandler (PostProcHandler $postProcHandler)
	setRecursiveTextProcessor (RecursiveTextProcessor $recursiveTextProcessor)
	setShowMode ( $mode)
	setCurtailmentMode ( $curtailmentMode)
	isQueryDisabled ()
	parse (array $functionParams)

Public Attributes
const	DEFERRED_REQUEST = '@deferred'
const	NO_TRACE = '@notrace'
const	IS_ANNOTATION = '@annotation'

Detailed Description

Provides the {{#ask}} parser function

See also

http://www.semantic-mediawiki.org/wiki/Help:Ask

GNU GPL v2+

Since

1.9

Author

Markus Krötzsch

Jeroen De Dauw

mwjames

Constructor & Destructor Documentation

__construct()

SMW\ParserFunctions\AskParserFunction::__construct	(	ParserData	$parserData,
		MessageFormatter	$messageFormatter,
		CircularReferenceGuard	$circularReferenceGuard,
		ExpensiveFuncExecutionWatcher	$expensiveFuncExecutionWatcher
	)

Since

1.9

Parameters

ParserData	$parserData
MessageFormatter	$messageFormatter
CircularReferenceGuard	$circularReferenceGuard
ExpensiveFuncExecutionWatcher	$expensiveFuncExecutionWatcher

Member Function Documentation

isQueryDisabled()

SMW\ParserFunctions\AskParserFunction::isQueryDisabled

(

)

{{#ask}} is disabled (see $smwgQEnabled)

Since

1.9

Returns

string|null

parse()

SMW\ParserFunctions\AskParserFunction::parse

(

array

$functionParams

)

Parse parameters, return results from the query printer and update the ParserOutput with meta data from the query

FIXME $rawParams use IParameterFormatter -> QueryParameterFormatter class Parse parameters and return query results to the ParserOutput object and output result data from the QueryProcessor

Todo:

$rawParams should be of IParameterFormatter QueryParameterFormatter class

Since

1.9

Parameters

array

$functionParams

Returns

string|null

setCurtailmentMode()

SMW\ParserFunctions\AskParserFunction::setCurtailmentMode

(

$curtailmentMode

)

Since

3.1

Parameters

boolean

$curtailmentMode

setPostProcHandler()

SMW\ParserFunctions\AskParserFunction::setPostProcHandler

(

PostProcHandler

$postProcHandler

)

Since

3.0

Parameters

PostProcHandler

$postProcHandler

setRecursiveTextProcessor()

SMW\ParserFunctions\AskParserFunction::setRecursiveTextProcessor

(

RecursiveTextProcessor

$recursiveTextProcessor

)

Since

3.0

Parameters

RecursiveTextProcessor

$recursiveTextProcessor

setShowMode()

SMW\ParserFunctions\AskParserFunction::setShowMode

(

$mode

)

Enable showMode (normally only invoked by {{#show}})

Since

1.9

Returns

AskParserFunction

Member Data Documentation

DEFERRED_REQUEST

const SMW\ParserFunctions\AskParserFunction::DEFERRED_REQUEST = '@deferred'

Fixed identifier for a deferred query request

IS_ANNOTATION

const SMW\ParserFunctions\AskParserFunction::IS_ANNOTATION = '@annotation'

Fixed identifier to signal to the PostProcHandler that a post update is required with the output being used as input value for an annotation.

NO_TRACE

const SMW\ParserFunctions\AskParserFunction::NO_TRACE = '@notrace'

Fixed identifier

---

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

• AskParserFunction.php