MediaWiki master
MediaWiki Namespace Reference

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

Namespaces

namespace  Actions
 
namespace  Api
 
namespace  Auth
 
namespace  Block
 
namespace  Cache
 
namespace  Category
 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  ChangeTags
 
namespace  Collation
 
namespace  CommentFormatter
 
namespace  CommentStore
 
namespace  Composer
 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  Config
 
namespace  Content
 
namespace  Context
 
namespace  DAO
 
namespace  DB
 
namespace  Debug
 
namespace  Deferred
 
namespace  Edit
 
namespace  EditPage
 
namespace  Export
 
 
namespace  Feed
 
namespace  FileBackend
 
namespace  FileRepo
 
namespace  Hook
 
namespace  HookContainer
 
namespace  Html
 
namespace  HTMLForm
 
namespace  Http
 
namespace  Installer
 
namespace  Interwiki
 
namespace  JobQueue
 
namespace  Json
 
namespace  Language
 
namespace  Languages
 
namespace  Libs
 
namespace  LinkedData
 
namespace  Linker
 
namespace  Logger
 
namespace  Logging
 
namespace  Mail
 
namespace  Maintenance
 
namespace  Message
 
namespace  Navigation
 
namespace  Output
 
namespace  OutputTransform
 
namespace  Page
 
namespace  Pager
 
namespace  Parser
 
namespace  Password
 
namespace  Permissions
 
namespace  PoolCounter
 
namespace  Preferences
 
namespace  Profiler
 
namespace  RCFeed
 
namespace  Registration
 
namespace  RenameUser
 
namespace  Request
 
namespace  ResourceLoader
 
namespace  Rest
 
namespace  Revision
 
namespace  RevisionList
 
namespace  Search
 
namespace  Session
 
namespace  Settings
 
namespace  Shell
 
namespace  Site
 
namespace  SiteStats
 
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  Specials
 
namespace  Status
 
namespace  Storage
 
namespace  StubObject
 
namespace  Tidy
 
namespace  Title
 
namespace  User
 Utility class for bot passwords.
 
namespace  Utils
 
namespace  Watchlist
 
namespace  Widget
 
namespace  WikiMap
 
namespace  Xml
 

Classes

class  EntryPointEnvironment
 Utility class wrapping PHP runtime state. 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  MediaWikiEntryPoint
 Base class for entry point handlers. More...
 
class  MediaWikiServices
 Service locator for MediaWiki core services. More...
 
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 generic redirect handler for the REST API.

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.

A service class for looking up permissions bestowed to groups, groups bestowed with permissions, and permissions bestowed by membership in a combination of groups, solely according to site configuration for group permissions and inheritence thereof.

Registry of string sets used with ParserOutput::{get,append}OutputString() within MediaWiki core.

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

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

Filter that decides whether a ParserOutput object should be stored in the ParserCache or not.

Returns an instance of the ParserCache by its name.

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

Serializes things to JSON.

Deserializes things from JSON.

Classes implementing this interface support round-trip JSON serialization/deserialization using the JsonDeserializer utility.

Defines JSON-related constants.

Helper class to serialize/deserialize 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 deserialization to work. Use JsonDeserializableTrait in implementing classes which annotates the JSON automatically.

See also
JsonDeserializer
JsonDeserializableTrait
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 \Parser

Can be used tweak tradeoffs between storage space and response latency.

Since
1.42 \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

All string sets used should be defined in this class.

\Parser

This class does not account for implicit rights (which are not associated with groups). Callers might want to use {

See also
PermissionManager} if this is an issue.

This class does not infer membership in one group (e.g. '*') from membership in another (e.g. 'user'). Callers must account for this when using {

See also
self::getGroupPermissions()}.
Since
1.36 \Permissions
Access: internal
\Rest\BasicAccess

\Rest\Handler

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

\Rest\Handler

To declare a redirect in a route file, use the following structure:

{
"path": "/path/to/trigger/a/redirect/{foo}",
"redirect": {
"path": "/redirect/target/{foo}",
"code": 302
}
}

It is not necessary to specify the handler class. The default status code is 308. Path parameters and query parameters will be looped through.

Since
1.43 \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 preferably 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