[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/context/ -> IContextSource.php (summary)

Request-dependant objects containers. 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.

Author: Happy-melon
File Size: 117 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

IContextSource:: (11 methods):
  getRequest()
  getTitle()
  canUseWikiPage()
  getWikiPage()
  getOutput()
  getUser()
  getLanguage()
  getSkin()
  getConfig()
  msg()
  exportSession()


Interface: IContextSource  - X-Ref

Interface for objects which can provide a context on request.

getRequest()   X-Ref
Get the WebRequest object

return: WebRequest

getTitle()   X-Ref
Get the Title object

return: Title|null

canUseWikiPage()   X-Ref
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.

return: bool

getWikiPage()   X-Ref
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.

return: WikiPage

getOutput()   X-Ref
Get the OutputPage object

return: OutputPage

getUser()   X-Ref
Get the User object

return: User

getLanguage()   X-Ref
Get the Language object

return: Language

getSkin()   X-Ref
Get the Skin object

return: Skin

getConfig()   X-Ref
Get the site configuration

return: Config

msg()   X-Ref
Get a Message object with context set

return: Message

exportSession()   X-Ref
Export the resolved user IP, HTTP headers, user ID, and session ID.
The result will be reasonably sized to allow for serialization.

return: array



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1