Příručka:ApiBase.php

This page is a translated version of the page Manual:ApiBase.php and the translation is 100% complete.

Lokalita:

includes/api/ (1 v 1.46 nebo novější)

Zdrojový kód:

Třídy:

Třída ApiBase implementuje mnoho základních funkcí API a je základem všech tříd API. Funkce třídy jsou rozděleny do několika oblastí funkčnosti:

Module parameters (parametry modulu): Odvozené třídy mohou definovat getAllowedParams() pro určení, které parametry očekávat, jak je analyzovat a validovat.
Profiling(profilování): Různé metody umožňující sledování různých úkolů a jejich časových nákladů
Self-documentation (vlastní dokumentace): kód, který umožňuje API dokumentovat svůj vlastní stav

Funkce

getAllowedParams()

Určete, které parametry jsou povoleny a jaké požadavky na ně mají být kladeny. Konstanty PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, PARAM_RANGE_ENFORCE naleznete v dokumentaci v horní části souboru includes/api/ApiBase.php. Možné typy parametrů jsou: NULL, string, integer, limit, boolean, timestamp, user, upload. Parametr 'user' (uživatel) je uživatelské jméno, které je ověřeno pomocí Title::makeTitleSafe(). Pro booleovské parametry není povolena jiná výchozí hodnota než 'false'.

Příklad:

// Parametr Title.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ParamValidator::PARAM_TYPE => 'string',
                        ParamValidator::PARAM_REQUIRED => true
                ),
        );
}

getResult()

Získá výsledek API (viz Příručka:ApiResult.php ).

Háčky

APIGetAllowedParams

Háčky volané z tohoto souboru jsou uvedeny v kategorii Category:MediaWiki hooks included in ApiBase.php .

Významné změny

Třída se ve verzi MW 1.43 stala jmenným prostorem (MediaWiki\Api\ApiBase). Rozšíření musí odpovídajícím způsobem aktualizovat použití této třídy.

Související odkazy