Inheritance diagram for SMW\MediaWiki\Api\Task:

Collaboration diagram for SMW\MediaWiki\Api\Task:

Public Member Functions
	execute ()

	getAllowedParams ()

	getParamDescription ()

	getDescription ()

	needsToken ()

	mustBePosted ()

	isWriteMode ()

	getHelpUrls ()

	getVersion ()

Static Public Member Functions
static	makeCacheKey ( $key)

Public Attributes
const	CACHE_NAMESPACE = 'smw:api:task'

Protected Member Functions
	getExamples ()

	getExamplesMessages ()

Detailed Description

Module to support various tasks initiate using the API interface

GNU GPL v2+

Since: 3.0

Author: mwjames

Member Function Documentation

◆ execute()

SMW\MediaWiki\Api\Task::execute ( )

See also: ApiBase::execute

◆ getAllowedParams()

SMW\MediaWiki\Api\Task::getAllowedParams ( )

See also: ApiBase::getAllowedParams

Returns: array

◆ getDescription()

SMW\MediaWiki\Api\Task::getDescription ( )

See also: ApiBase::getDescription

Returns: array

◆ getExamples()

SMW\MediaWiki\Api\Task::getExamples ( )

protected

See also: ApiBase::getExamples

Returns: array

◆ getExamplesMessages()

SMW\MediaWiki\Api\Task::getExamplesMessages ( )

protected

See also: ApiBase::getExamplesMessages

Returns: array

◆ getHelpUrls()

SMW\MediaWiki\Api\Task::getHelpUrls ( )

See also: ApiBase::getExamplesMessages

Returns: string

◆ getParamDescription()

SMW\MediaWiki\Api\Task::getParamDescription ( )

See also: ApiBase::getParamDescription

Returns: array

◆ getVersion()

SMW\MediaWiki\Api\Task::getVersion ( )

See also: ApiBase::getVersion

Returns: string

◆ isWriteMode()

SMW\MediaWiki\Api\Task::isWriteMode ( )

See also: ApiBase::isWriteMode

◆ makeCacheKey()

static SMW\MediaWiki\Api\Task::makeCacheKey ( $key )

static

Since: 3.0

Parameters

string $key

Returns: string

◆ mustBePosted()

SMW\MediaWiki\Api\Task::mustBePosted ( )

See also: ApiBase::mustBePosted

◆ needsToken()

SMW\MediaWiki\Api\Task::needsToken ( )

See also: ApiBase::needsToken

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

Task.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions