MediaWiki Namespace Reference

Helper trait for implementations \DAO. More...

Namespaces
namespace	Actions
namespace	Api
namespace	Auth
namespace	Block
namespace	Cache
namespace	Category
namespace	ChangeTags
namespace	Collation
namespace	CommentFormatter
namespace	CommentStore
namespace	Composer
	Copyright (C) 2017 Kunal Mehta legok.nosp@m.tm@d.nosp@m.ebian.nosp@m..org
namespace	Config
namespace	Content
namespace	Context
namespace	DAO
namespace	DB
namespace	Debug
namespace	Deferred
namespace	DomainEvent
namespace	Edit
namespace	EditPage
namespace	Exception
namespace	Export
namespace	ExternalLinks
namespace	Feed
namespace	FileBackend
namespace	FileRepo
namespace	Gallery
namespace	Hook
namespace	HookContainer
namespace	Html
namespace	HTMLForm
namespace	Http
namespace	Installer
namespace	Interwiki
namespace	JobQueue
namespace	Json
namespace	Language
namespace	LinkedData
namespace	Linker
namespace	Logger
namespace	Logging
namespace	Mail
namespace	Maintenance
	Update the CREDITS list by merging in the list of git commit authors.
namespace	Message
namespace	Navigation
namespace	Notification
namespace	Output
namespace	OutputTransform
namespace	Page
namespace	Pager
namespace	Parser
namespace	Password
namespace	Permissions
namespace	PoolCounter
namespace	Preferences
namespace	Profiler
namespace	RCFeed
namespace	RecentChanges
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
namespace	Sparql
namespace	SpecialPage
namespace	Specials
namespace	Status
namespace	Storage
namespace	StubObject
namespace	Telemetry
namespace	Tidy
namespace	Title
namespace	Upload
namespace	User
namespace	Utils
namespace	Watchlist
namespace	Widget
namespace	WikiMap
namespace	Xml

Classes
class	EntryPointEnvironment
	Utility class wrapping PHP runtime state. More...
class	FeatureShutdown
	Helper to check if certain features should be temporarily disabled. More...
class	MainConfigNames
	A class containing constants representing the names of configuration variables. More...
class	MediaWikiEntryPoint
	Base class for entry point handlers. More...
class	MediaWikiServices
	Service locator for MediaWiki core services. More...

Detailed Description

Helper trait for implementations \DAO.

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 linter errors for main (text) content revisions.

A generic redirect handler for the REST API.

A handler that returns linter errors for main (text) content of pages.

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::{getLinkList,appendLink}() 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 MessageSpecifier objects 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.

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

Deprecated

since 1.45; use JsonCodecable in new code

Since

1.36 \Json

Deprecated

since 1.45; use JsonCodecInterface

Stability: stable

to type

Since

1.36 \Json

Deprecated

since 1.45; use JsonCodecInterface

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

Since

1.38

All link types used should be defined in this class.

\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