Manual:ApiBase.php/ru

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


 * Параметры модулей: Производные классы могут определить, чтобы указать, какие параметры получать, как их разбирать и подтверждать их правильность.

getAllowedParams
Укажите, какие параметры разрешены и какие требования следует накладывать на них. См. документацию, начинающуюся со строки 46 для просмотра констант 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» — имя участника, проверяемое с использованием. Для булевых параметров разрешено единственное значение по умолчанию — false.

Пример:

getResultProperties и getFinalResultProperties
НУЖНО СДЕЛАТЬ: описать, что они делают

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

Привязки
Hooks called from this file are listed in the MediaWiki hooks included in ApiBase.php category.

См. также

 * API Implementation Strategy
 * API Extensions
 * Manual:Code
 * Manual:Code