Manual:ApiBase.php/ru

Класс  реализует много основных функций API и является основой всех классов API. Функции класса делятся на несколько групп по применению: The class functions are divided into several areas of functionality:


 * Параметры модулей: Производные классы могут определять, чтобы указать, какие параметры ожидать, как их разбирать и проверять их правильность.
 * Профилирование: различные методы, позволяющие вести учёт различных задач и их временных затрат
 * Самодокументация: код, позволяющий API документировать своё собственное состояние
 * Profiling: various methods to allow keeping tabs on various tasks and their time costs
 * Self-documentation: code to allow the API to document its own state

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

Привязки


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

См. также

 * Стратегия реализации API