Руководство:ApiBase.php

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

Outdated translations are marked like this.

Файл MediaWiki: ApiBase.php

Расположение:

includes/api/ (includes/Api/ in 1.46 or later)

Исходный код:

master • 1.45.3 • 1.44.5 • 1.43.8

Классы:

MediaWiki\Api\ApiBase

Класс ApiBase реализует много основных функций API и является основой всех классов API. Функции класса делятся на несколько групп по применению:

Параметры модулей: Производные классы могут определять getAllowedParams(), чтобы указать, какие параметры ожидать, как их разбирать и проверять их правильность.
Профилирование: различные методы, позволяющие вести учёт различных задач и их временных затрат
Самодокументация: код, позволяющий API документировать своё собственное состояние

Функции

getAllowedParams()

Укажите, какие параметры разрешены и какие требования следует накладывать на них. См. начало документации $apiBase для просмотра констант PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED и PARAM_RANGE_ENFORCE. Возможные типы параметров — NULL, string, integer, limit, boolean, timestamp, user или upload. Параметр типа «user» — имя участника, проверяемое с использованием Title::makeTitleSafe(). Для булевых параметров разрешено единственное значение по умолчанию — false. See the documentation at the top of includes/api/ApiBase.php for the constants PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, PARAM_RANGE_ENFORCE. The possible types of parameters are NULL, string, integer, limit, boolean, timestamp, user, or upload. A "user" parameter is a username that is validated using Title::makeTitleSafe(). For boolean parameters, a default value of anything other than false is not allowed.

Пример:

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

getResult()

Получает результат API (см. Manual:ApiResult.php ).

Привязки

APIGetAllowedParams

Привязки, вызываемые из этого файла, перечислены в категории Category:MediaWiki hooks included in ApiBase.php .

Notable changes

The class became namespaced (MediaWiki\Api\ApiBase) in MW 1.43. Extensions must update uses of this class accordingly.

См. также