/**
* @deprecated since 1.28, use SessionManager::invalidateSessionForUser() instead.
+ * @return bool
*/
public function resetAuthToken() {
# Override this!
/**
* @since 1.25
+ * @param string $url
*/
public function setRequestURL( $url ) {
$this->requestUrl = $url;
/**
* @since 1.25 MWException( "getRequestURL not implemented" )
* no longer thrown.
+ * @return string
*/
public function getRequestURL() {
if ( $this->requestUrl === null ) {
* @since 1.16.3
* @deprecated since 1.28, use MediaWiki\Linker\LinkRenderer instead
* @see Linker::link
+ * @param Title $target
+ * @param string $html
+ * @param array $customAttribs
+ * @param array $query
+ * @param string|array $options
* @return string
*/
public static function linkKnown(
* @param bool $filter Whether to filter out insufficiently trustworthy modules
* @param string|null $position If not null, only return modules with this position
* @param string $param
+ * @param string $type
* @return array Array of module names
*/
public function getModules( $filter = false, $position = null, $param = 'mModules',
/**
* Dummy, kept for backwards-compatibility.
+ * @param User $user
+ * @param IContextSource $context
+ * @param array &$defaultPreferences
*/
static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) {
}
* protocol-relative, the URL will be expanded to http://
*
* @see self::getLocalURL for the arguments.
+ * @param string $query
+ * @param string|bool $query2
* @return string The URL
*/
public function getInternalURL( $query = '', $query2 = false ) {
* @since 1.22
* @deprecated since 1.29 Use RCFeed::factory() instead
* @param string $uri URI to get the engine object for
+ * @param array $params
* @return RCFeedEngine The engine object
* @throws MWException
*/
*
* @see listSoftwareDefinedTags
* @deprecated since 1.28
+ * @return array
*/
public static function listExtensionDefinedTags() {
wfDeprecated( __METHOD__, '1.28' );
/**
* @param string $cond
+ * @param bool $orderRevs
* @throws MWException
* @throws Exception
*/
/**
* @see FileBackendStore::__construct()
- * Additional $config params include:
+ * @param array $config Params include:
* - swiftAuthUrl : Swift authentication server URL
* - swiftUser : Swift user used by MediaWiki (account:username)
* - swiftKey : Swift authentication key for the above user
}
/**
- * @deprecated since 1.30, use MediaHandler::getContentHeaders instead
- */
+ * @deprecated since 1.30, use MediaHandler::getContentHeaders instead
+ * @param array $metadata
+ * @return array
+ */
public function getStreamHeaders( $metadata ) {
wfDeprecated( __METHOD__, '1.30' );
return $this->getContentHeaders( $metadata );
/**
* Extracts the image size and WebP type from a file based on the chunk list
* @param array $chunks Chunks as extracted by RiffExtractor
+ * @param string $filename
* @return array Header data array with entries 'compression', 'width' and 'height', where
* 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'
*/
/**
* Process completion search results.
* Resolves the titles and rescores.
+ * @param string $search
* @param SearchSuggestionSet $suggestions
* @return SearchSuggestionSet
*/
/**
* @warning If you pass false to this constructor, then
* the caller is responsible for HTML escaping.
+ * @param bool $cleanupWikitext
*/
function __construct( $cleanupWikitext = true ) {
$this->mCleanWikitext = $cleanupWikitext;
* be able to extract the timestamp.
*
* @param string $token
- * @param int|null
+ * @return int|null
*/
public static function getTimestamp( $token ) {
$suffixLen = strlen( self::SUFFIX );
/**
* Returns a string that can be appended to the URL (without encoding) to preserve the
* return target. Does not include leading '?'/'&'.
+ * @return string
*/
protected function getReturnToQueryStringFragment() {
$returnto = '';
/**
* @param array &$formDescriptor
+ * @param array $requests
*/
protected function postProcessFormDescriptor( &$formDescriptor, $requests ) {
// Pre-fill username (if not creating an account, T46775).
/**
* Extensions (AntiSpoof and TitleBlacklist) call this in response to
* UserCreateForm hook to add checkboxes to the create account form.
+ * @param string $name
+ * @param string $value
+ * @param string $type
+ * @param string $msg
+ * @param string|bool $helptext
*/
public function addInputItem( $name, $value, $type, $msg, $helptext = false ) {
// use the same indexes as UserCreateForm just in case someone adds an item manually
/**
* @deprecated since 1.27 - call LoginHelper::getValidErrorMessages instead.
+ * @return array
*/
public static function getValidErrorMessages() {
return LoginHelper::getValidErrorMessages();
/**
* @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+ * @param string $username
+ * @return array|false
*/
public static function incrementLoginThrottle( $username ) {
wfDeprecated( __METHOD__, "1.27" );
/**
* @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+ * @param string $username
+ * @return bool|int
*/
public static function incLoginThrottle( $username ) {
wfDeprecated( __METHOD__, "1.27" );
/**
* @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+ * @param string $username
+ * @return void
*/
public static function clearLoginThrottle( $username ) {
wfDeprecated( __METHOD__, "1.27" );
/**
* @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+ * @return string
*/
public static function getCreateaccountToken() {
wfDeprecated( __METHOD__, '1.27' );
* come out of querycache table is the order they went in. Which is hacky.
* However, other special pages like Special:Deadendpages and
* Special:BrokenRedirects also rely on this.
+ * @return array
*/
public function getQueryInfo() {
$dbr = wfGetDB( DB_REPLICA );
* Output the start of the table
*
* Including opening <table>, and first <tr> with column headers.
+ * @param string $mediaType
*/
protected function outputTableStart( $mediaType ) {
$this->getOutput()->addHTML(
* @param string $type PUBLIC or SYSTEM
* @param string $publicId The well-known public identifier for the dtd
* @param string $systemId The url for the external dtd
+ * @return bool|array
*/
public static function checkSvgExternalDTD( $type, $publicId, $systemId ) {
// This doesn't include the XHTML+MathML+SVG doctype since we don't
* @todo Replace this with a whitelist filter!
* @param string $element
* @param array $attribs
+ * @param array $data
* @return bool
*/
public function checkSvgScriptCallback( $element, $attribs, $data = null ) {
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude name="Generic.ControlStructures.InlineControlStructure" />
<!-- Disable rules added in 0.8.0 that don't pass yet -->
- <exclude name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Commenting.FunctionComment.Missing.Protected" />
<exclude name="MediaWiki.Commenting.FunctionComment.Missing.Public" />
<exclude name="MediaWiki.Commenting.FunctionComment.SpacingAfter" />