*/
const PARAM_TEMPLATE_VARS = 25;
- /**@}*/
+ /** @} */
const ALL_DEFAULT_STRING = '*';
/** $var array Map of web UI block messages to corresponding API messages and codes */
private static $blockMsgMap = [
'blockedtext' => [ 'apierror-blocked', 'blocked' ],
- 'blockedtext-partial' => [ 'apierror-blocked', 'blocked' ],
+ 'blockedtext-partial' => [ 'apierror-blocked-partial', 'blocked' ],
'autoblockedtext' => [ 'apierror-autoblocked', 'autoblocked' ],
'systemblockedtext' => [ 'apierror-systemblocked', 'blocked' ],
+ 'blockedtext-composite' => [ 'apierror-blocked', 'blocked' ],
];
/** @var ApiMain */
return null;
}
- /**@}*/
+ /** @} */
/************************************************************************//**
* @name Data access methods
return MediaWikiServices::getInstance()->getPermissionManager();
}
- /**@}*/
+ /** @} */
/************************************************************************//**
* @name Parameter handling
);
}
- /**@}*/
+ /** @} */
/************************************************************************//**
* @name Utility methods
} );
}
- /**@}*/
+ /** @} */
/************************************************************************//**
* @name Warning and error reporting
wfDebugLog( 'api-feature-usage', $s, 'private', $ctx );
}
- /**@}*/
+ /** @} */
/************************************************************************//**
* @name Help message generation
public function modifyHelp( array &$help, array $options, array &$tocData ) {
}
- /**@}*/
-
- /************************************************************************//**
- * @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",
- ] ];
- }
-
- /**@}*/
+ /** @} */
}
/**