From: James D. Forrester Date: Mon, 24 Jun 2019 23:43:59 +0000 (-0700) Subject: ApiBase: Drop get(Examples|(Param)?Description(Message)?)\(\), deprecated since 1... X-Git-Tag: 1.34.0-rc.0~1218^2 X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=a4d976fc833193c3a19c082de77d52b69cf2cb1d ApiBase: Drop get(Examples|(Param)?Description(Message)?)\(\), deprecated since 1.25 and 1.30 Change-Id: Ie62436692f39825237d36002aa01bedf1caa1fa3 --- diff --git a/RELEASE-NOTES-1.34 b/RELEASE-NOTES-1.34 index aa61d3147e..fdf26166dd 100644 --- a/RELEASE-NOTES-1.34 +++ b/RELEASE-NOTES-1.34 @@ -254,6 +254,10 @@ because of Phabricator reports. * Database::reportConnectionError, deprecated in 1.32, has been removed. * APIEditBeforeSave hook, deprecated in 1.28, has been removed. Please see EditFilterMergedContent hook for an alternative way to use this feature. +* API module methods getDescription(), getParamDescription(), & getExamples(), + all deprecated in 1.25 and ignored, have been removed. +* The API module method getDescriptionMessage(), deprecated in 1.30, has been + removed. * … === Deprecations in 1.34 === diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 5687f0f7d9..e798414a6f 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -2629,81 +2629,6 @@ abstract class ApiBase extends ContextSource { } /**@}*/ - - /************************************************************************//** - * @name Deprecated - * @{ - */ - - /** - * Returns the description string for this module - * - * Ignored if an i18n message exists for - * "apihelp-{$this->getModulePath()}-description". - * - * @deprecated since 1.25 - * @return Message|string|array|false - */ - protected function getDescription() { - wfDeprecated( __METHOD__, '1.25' ); - return false; - } - - /** - * Returns an array of parameter descriptions. - * - * For each parameter, ignored if an i18n message exists for the parameter. - * By default that message is - * "apihelp-{$this->getModulePath()}-param-{$param}", but it may be - * overridden using ApiBase::PARAM_HELP_MSG in the data returned by - * self::getFinalParams(). - * - * @deprecated since 1.25 - * @return array|bool False on no parameter descriptions - */ - protected function getParamDescription() { - wfDeprecated( __METHOD__, '1.25' ); - return []; - } - - /** - * Returns usage examples for this module. - * - * Return value as an array is either: - * - numeric keys with partial URLs ("api.php?" plus a query string) as - * values - * - sequential numeric keys with even-numbered keys being display-text - * and odd-numbered keys being partial urls - * - partial URLs as keys with display-text (string or array-to-be-joined) - * as values - * Return value as a string is the same as an array with a numeric key and - * that value, and boolean false means "no examples". - * - * @deprecated since 1.25, use getExamplesMessages() instead - * @return bool|string|array - */ - protected function getExamples() { - wfDeprecated( __METHOD__, '1.25' ); - return false; - } - - /** - * Return the description message. - * - * This is additional text to display on the help page after the summary. - * - * @deprecated since 1.30 - * @return string|array|Message - */ - protected function getDescriptionMessage() { - wfDeprecated( __METHOD__, '1.30' ); - return [ [ - "apihelp-{$this->getModulePath()}-description", - "apihelp-{$this->getModulePath()}-summary", - ] ]; - } - - /**@}*/ } /**