MediaWiki\Extension\WikiLambda\API\ApiFunctionCall Class Reference

Inheritance diagram for MediaWiki\Extension\WikiLambda\API\ApiFunctionCall:

Collaboration diagram for MediaWiki\Extension\WikiLambda\API\ApiFunctionCall:

Public Member Functions
	__construct ( $query, $moduleName)
	@inheritDoc
	execute ()
	@inheritDoc
	executeGenerator ( $resultPageSet)
	@inheritDoc
Public Member Functions inherited from MediaWiki\Extension\WikiLambda\API\WikiLambdaApiBase
	dieWithZError ( $zerror)

Static Public Member Functions
static	makeRequest ( $call)
	A convenience function for making a ZFunctionCall and returning its result to embed within a page.
static	wrapMessageInZError ( $message, $call)
	Convenience method to wrap a non-error in a Z507/Evaluation ZError.

Protected Member Functions
	getAllowedParams ()
	@inheritDoc @codeCoverageIgnore
	getExamplesMessages ()

Protected Attributes
	$orchestrator

Member Function Documentation

getExamplesMessages()

MediaWiki\Extension\WikiLambda\API\ApiFunctionCall::getExamplesMessages ( )

protected

See also

ApiBase::getExamplesMessages()

Returns

array @codeCoverageIgnore

makeRequest()

static MediaWiki\Extension\WikiLambda\API\ApiFunctionCall::makeRequest ( $call )

static

A convenience function for making a ZFunctionCall and returning its result to embed within a page.

Parameters

string

$call

The ZFunctionCall to make, as a JSON object turned into a string

Returns

string Currently the only permissable response objects are strings

Exceptions

ZErrorException

When the request is responded to oddly by the orchestrator

wrapMessageInZError()

static MediaWiki\Extension\WikiLambda\API\ApiFunctionCall::wrapMessageInZError ( $message, $call )

static

Convenience method to wrap a non-error in a Z507/Evaluation ZError.

TODO (T311480): This is used by two different APIs. Move to the ZErrorFactory, which is where all the error creating convenience methods are right now.

Parameters

string | ZObject	$message	The non-error to wrap.
string	$call	The functional call context.

Returns

ZError

---

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

• includes/API/ApiFunctionCall.php