IContextSource Interface Reference

Interface for objects which can provide a context on request. More...

Inheritance diagram for IContextSource:

List of all members.

Public Member Functions
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.
	getLang ()
	Get the Language object.
	getLanguage ()
	Get the Language object.
	getOutput ()
	Get the OutputPage object.
	getRequest ()
	Get the WebRequest object.
	getSkin ()
	Get the Skin object.
	getTitle ()
	Get the Title object.
	getUser ()
	Get the User object.
	getWikiPage ()
	Get the WikiPage object.
	msg ()
	Get a Message object with context set.

---

Detailed Description

Interface for objects which can provide a context on request.

Definition at line 29 of file IContextSource.php.

---

Member Function Documentation

IContextSource::canUseWikiPage

(

)

Check whether a WikiPage object can be get with getWikiPage().

Callers should expect that an exception is thrown from getWikiPage() if this method returns false.

Since:

1.19

Returns:

bool

Implemented in DerivativeContext, RequestContext, and ContextSource.

IContextSource::exportSession

(

)

Export the resolved user IP, HTTP headers, user ID, and session ID.

The result will be reasonably sized to allow for serialization.

Returns:

Array

Since:

1.21

Implemented in RequestContext, and ContextSource.

IContextSource::getLang

(

)

Get the Language object.

Deprecated:

since 1.19 Use getLanguage instead

Returns:

Language

Implemented in RequestContext, DerivativeContext, and ContextSource.

IContextSource::getLanguage

(

)

Get the Language object.

Returns:

Language

Since:

1.19

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by SpecialPageFactory\capturePath(), Preferences\datetimePreferences(), Preferences\generateSkinOptions(), Preferences\getDateOptions(), MWDebug\getDebugInfo(), MWDebug\getFilesIncluded(), Block\getPermissionsError(), Preferences\profilePreferences(), Preferences\skinPreferences(), and HTMLFileCache\useFileCache().

IContextSource::getOutput

(

)

Get the OutputPage object.

Returns:

OutputPage

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by SpecialPageFactory\capturePath(), SpecialPageFactory\executePath(), HTMLFileCache\loadFromFileCache(), and Preferences\profilePreferences().

IContextSource::getRequest

(

)

Get the WebRequest object.

Returns:

WebRequest

Implemented in DerivativeContext, RequestContext, and ContextSource.

Referenced by NewFilesPager\__construct(), ImageListPager\__construct(), SpecialPageFactory\capturePath(), SpecialPageFactory\executePath(), MWDebug\getDebugInfo(), Block\getPermissionsError(), Preferences\profilePreferences(), and HTMLFileCache\useFileCache().

IContextSource::getSkin

(

)

Get the Skin object.

Returns:

Skin

Implemented in RequestContext, DerivativeContext, and ContextSource.

IContextSource::getTitle

(

)

Get the Title object.

Returns:

Title

Implemented in ImageHistoryPseudoPager, HTMLForm, ImageListPager, AllmessagesTablePager, ProtectedTitlesPager, DerivativeContext, RequestContext, and ContextSource.

Referenced by Preferences\profilePreferences().

IContextSource::getUser

(

)

Get the User object.

Returns:

User

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by SpecialPageFactory\capturePath(), ApiLogin\execute(), SpecialBlock\processForm(), SpecialUnblock\processUnblock(), Preferences\profilePreferences(), and HTMLFileCache\useFileCache().

IContextSource::getWikiPage

(

)

Get the WikiPage object.

May throw an exception if there's no Title object set or the Title object belongs to a special namespace that doesn't have WikiPage, so use first canUseWikiPage() to check whether this method can be called safely.

Since:

1.19

Returns:

WikiPage

Implemented in RequestContext, DerivativeContext, and ContextSource.

IContextSource::msg

(

)

Get a Message object with context set.

Returns:

Message

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by Preferences\editingPreferences(), Preferences\generateSkinOptions(), Preferences\getDateOptions(), Preferences\getFormObject(), Preferences\getImageSizes(), Linker\getInvalidTitleDescription(), Block\getPermissionsError(), Preferences\getThumbSizes(), Preferences\getTimezoneOptions(), Preferences\profilePreferences(), Preferences\rcPreferences(), Preferences\renderingPreferences(), Preferences\searchPreferences(), Preferences\skinPreferences(), and Preferences\watchlistPreferences().

---

The documentation for this interface was generated from the following file:

• includes/context/IContextSource.php