Open main menu

Kézikönyv:$wgAPIModules

This page is a translated version of the page Manual:$wgAPIModules and the translation is 100% complete.
Other languages:
English • ‎español • ‎magyar • ‎polski • ‎中文 • ‎日本語
Extensions: $wgAPIModules
Az API-modul kiterjesztései.
Bevezetve:1.11.0 (r25364)
Eltávolítva:használatban
Megengedett értékek:(tömb)
Alapértelmezett érték:[]

Részletek

Az asszociatív tömb a modulnevet az osztálynévhez rendeli hozzá. A kiterjesztések moduljai felülírhatják a gyári modulokat (amelyek a ApiMain.php -ben vannak inicializálva).

Példa

Tételezzük fel, hogy a wiki remekségi szintjét kalibráló API-modult szeretnél készítenél. Ehhez el kell készítened a CalibrateAwesomeness-t, majd a CalibrateAwesomeness.php-ban el kell helyezned az alábbi kódot:

$wgAutoloadClasses['ApiCalibrateAwesomeness'] = __DIR__ . 'ApiCalibrateAwesomeness.php';
$wgAPIModules['calibrateawesomeness'] = 'ApiCalibrateAwesomeness';

Ezután el kell készítened az ApiCalibrateAwesomeness.php-t, amelyben az ApiCalibrateAwesomeness osztály kibontja mondjuk az ApiBase -t; például:

class ApiCalibrateAwesomeness extends ApiBase {
	public function execute() {
	...
	}

	public function getAllowedParams() {
		return array(
			'level' => array (
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_REQUIRED => true
			)
		);
	}
}

Az angol Wikipédiára való telepítés után a modult a https://en.wikipedia.org/w/api.php?action=calibrateawesomeness&level=1000 címen érheted el.

Ha az API-modul létrehozásához egy gyármodult használnál, azt az alábbi módon definiálhatod:

$wgAPIModules['calibrateawesomeness'] = [
    'class' => 'ApiCalibrateAwesomeness',
    'factory' => 'ApiCalibrateAwesomenessFactory::create',
];

ahol a class az API-modul osztálya, a factory pedig [1]-hívási érték.

Lásd még