MediaWiki REL1_39
MediaWiki Namespace Reference

A helper class for throttling authentication attempts. More...

Namespaces

namespace  Actions
 
namespace  Api
 
namespace  Auth
 
namespace  Block
 
namespace  Cache
 
namespace  ChangeTags
 
namespace  Collation
 
namespace  CommentFormatter
 
namespace  Config
 
namespace  Content
 
namespace  DAO
 
namespace  DB
 
namespace  Debug
 
namespace  Diff
 
namespace  Edit
 
namespace  EditPage
 
namespace  Export
 
namespace  Hook
 
namespace  HookContainer
 
namespace  Http
 
namespace  Installer
 
namespace  Interwiki
 Copyright (C) 2018 Kunal Mehta legok.nosp@m.tm@d.nosp@m.ebian.nosp@m..org
 
namespace  JobQueue
 
namespace  Json
 
namespace  Languages
 
namespace  Linker
 
namespace  Logger
 
namespace  Mail
 
namespace  Maintenance
 
namespace  Message
 
namespace  Navigation
 
namespace  Page
 
namespace  Parser
 
namespace  Permissions
 
namespace  Preferences
 
namespace  ResourceLoader
 
namespace  Rest
 
namespace  Revision
 
namespace  Search
 
namespace  Session
 
namespace  Settings
 
namespace  Shell
 
namespace  Site
 
namespace  Skin
 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
 
namespace  Sparql
 
namespace  SpecialPage
 
namespace  Storage
 
namespace  Tidy
 
namespace  User
 
namespace  Utils
 
namespace  Watchlist
 
namespace  Widget
 

Classes

class  BadFileLookup
 
interface  Emptiable
 An interface to check for emptiness of an object. More...
 
class  ExtensionInfo
 
class  HeaderCallback
 
class  HtmlHelper
 Static utilities for manipulating HTML strings. More...
 
class  MainConfigNames
 A class containing constants representing the names of configuration variables. More...
 
class  MainConfigSchema
 This class contains schema declarations for all configuration variables known to MediaWiki core. More...
 
class  MediaWikiServices
 Service locator for MediaWiki core services. More...
 
class  OutputHandler
 
class  ProcOpenError
 
class  ShellDisabledError
 

Detailed Description

A helper class for throttling authentication attempts.

Service for looking up UserIdentity.

ActorStore factory for various domains.

Service for interacting with the actor table.

Simple in-memory cache for UserIdentity objects indexed by user ID, actor ID and user name.

Provides an instance of CsrfTokenSet.

Stores and matches CSRF tokens belonging to a given session user.

This trait can be used on handlers that choose to support token-based CSRF protection.

A handler base class which unpacks parameters from the path template and passes them as formal parameters to run().

A handler that returns Parsoid HTML for the following routes:

Class LanguageLinksHandler REST API handler for /page/{title}/links/language endpoint.

Wraps an array of BasicAuthorizerInterface and checks them all to authorize the request.

Lookup permissions for groups and groups with permissions.

Registry of flags used with ParserOutput::{get,set}OutputFlag() within MediaWiki core.

For observing and detecting parser behaviors, such as duplicate parses.

Returns an instance of the ParserCache by its name.

Converts MessageValue message specifiers to localized plain text in a certain language.

Deserializes things from JSON.

Classes implementing this interface support round-trip JSON serialization/unserialization using the JsonUnserializer utility.

Serializes things to JSON.

Defines JSON-related constants.

Helper class to serialize/unserialize things to/from JSON.

Helper trait for implementations \DAO.

Class ContentHandlerFactory \Content.

\Auth

Since
1.27
1.35
Stability: stable
to type
Since
1.36 \Json
Access: internal
\Json

The resulting JSON must be annotated with class information for unserialization to work. Use JsonUnserializableTrait in implementing classes which annotates the JSON automatically.

See also
JsonUnserializer
JsonUnserializableTrait
Since
1.36 \Json
1.36 \Json

The caller cannot modify the details of message translation, such as which of multiple sources the message is taken from. Any such flags may be injected into the factory constructor.

Implementations of TextFormatter are not required to perfectly format any message in any language. Implementations should make a best effort to produce human-readable text.

\MessageFormatter

Since
1.36 \Mail
1.36 \Parser
Access: internal
\Parser

All flags used should be defined in this class.

It is recommended that new flag names in core should begin with 'mw-' in order to prevent namespace conflicts with legacy flags.

\Parser

Since
1.36 \Permissions
Access: internal
\Rest\BasicAccess

\Rest\Handler

  • /page/{title}/html,
  • /page/{title}/with_html

\Rest\Handler

  • /revision/{revision}/html,
  • /revision/{revision}/with_html

Class RevisionHTMLHandler \Rest\Handler

run() must be declared in the subclass. It cannot be declared as abstract here because it has a variable parameter list.

Stability: stable
to extend \Rest

Note that doing so is discouraged, and you should preferrably require that the endpoint be used with a session provider that is safe against CSRF, such as OAuth.

See also
Handler::requireSafeAgainstCsrf()

\Rest

Since
1.37 \Session

We cannot just use MapCacheLRU for this because of eviction semantics: we need to be able to remove UserIdentity from the cache even if user ID or user name has changed, so we track the most accessed VALUES in the cache, not keys, and evict them alongside with all their indexes.

Since
1.37
Access: internal
for use by ActorStore \User

\User

Since
1.36
1.37 \User\CentralId