WikiLambda
MediaWiki WikiLambda extension
Loading...
Searching...
No Matches
MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall Class Reference
+ Inheritance diagram for MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall:
+ Collaboration diagram for MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall:

Public Member Functions

 __construct ( $query, $moduleName)
 @inheritDoc
 
 execute ()
 @inheritDoc
 
 executeGenerator ( $resultPageSet)
 @inheritDoc
 
 isInternal ()
 Mark as internal.
 
- Public Member Functions inherited from MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase
 dieWithZError ( $zerror, $code=400)
 
 setLogger (LoggerInterface $logger)
 @inheritDoc
 
 getLogger ()
 @inheritDoc
 

Static Public Member Functions

static makeRequest ( $call)
 A convenience function for making a ZFunctionCall and returning its result to embed within a page.
 

Protected Member Functions

 getAllowedParams ()
 @inheritDoc @codeCoverageIgnore
 
 getExamplesMessages ()
 
- Protected Member Functions inherited from MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase
 setUp ()
 
 executeFunctionCall ( $zObject, $validate)
 

Additional Inherited Members

- Protected Attributes inherited from MediaWiki\Extension\WikiLambda\ActionAPI\WikiLambdaApiBase
OrchestratorRequest $orchestrator
 
string $orchestratorHost
 
LoggerInterface $logger
 

Member Function Documentation

◆ getExamplesMessages()

MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall::getExamplesMessages ( )
protected
See also
ApiBase::getExamplesMessages()
Returns
array @codeCoverageIgnore

◆ isInternal()

MediaWiki\Extension\WikiLambda\ActionAPI\ApiFunctionCall::isInternal ( )

Mark as internal.

This isn't meant to be user-facing, and can change at any time.

Returns
bool

◆ makeRequest()

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

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

Parameters
string$callThe ZFunctionCall to make, as a JSON object turned into a string
Returns
string Currently the only permissable response objects are strings
Exceptions
ZErrorExceptionWhen the request is responded to oddly by the orchestrator
+ Here is the caller graph for this function:

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