MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase Class Reference

WikiLambda Base API util. More...

Inheritance diagram for MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase:

Collaboration diagram for MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase:

Public Member Functions
	execute ()
	@inheritDoc
	setLogger (LoggerInterface $logger)
	@inheritDoc
	getLogger ()
	@inheritDoc
	submitMetricsEvent ( $action, $eventData)

Static Public Member Functions
static	dieWithZError ( $zerror, $code=400)

Protected Member Functions
	setUp ()
	run ()
	@inheritDoc
	executeFunctionCall ( $zObject, $validate)

Protected Attributes
OrchestratorRequest	$orchestrator
string	$orchestratorHost
LoggerInterface	$logger

Detailed Description

WikiLambda Base API util.

This abstract class extends the Wikimedia's ApiBase class and provides specific additional methods.

@stable to extend

Copyright

2020– Abstract Wikipedia team; see AUTHORS.txt @license MIT

Member Function Documentation

dieWithZError()

static MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase::dieWithZError ( $zerror, $code = 400 )

static

Parameters

ZError	$zerror	The ZError object to return to the user
int	$code	HTTP error code, defaulting to 400/Bad Request

Returns

never

Here is the caller graph for this function:

executeFunctionCall()

MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase::executeFunctionCall ( $zObject, $validate )

protected

Parameters

ZFunctionCall | \stdClass	$zObject
bool	$validate

Returns

ZResponseEnvelope

Here is the call graph for this function:

Here is the caller graph for this function:

run()

MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase::run ( )

protected

@inheritDoc

Reimplemented in MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall, MediaWiki\Extension\WikiLambda\ActionAPI\ApiPerformTest, MediaWiki\Extension\WikiLambda\ActionAPI\ApiSupportedProgrammingLanguages, MediaWiki\Extension\WikiLambda\ActionAPI\ApiZObjectEditor, MediaWiki\Extension\WikiLambda\ActionAPI\ApiZObjectFetcher, and MediaWiki\Extension\WikiLambda\PublicAPI\PublicApiRun.

Here is the call graph for this function:

Here is the caller graph for this function:

submitMetricsEvent()

MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase::submitMetricsEvent	(		$action,
			$eventData )

Parameters

string	$action	An arbitrary string describing what's being recorded
array	$eventData	Key-value pairs stating various characteristics of the action; these must conform to the specified schema.

---

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

• includes/ActionAPI/WikiLambdaApiBase.php