[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/context/ -> DerivativeContext.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: Daniel Friesen
File Size: 307 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

DerivativeContext:: (19 methods):
  __construct()
  setConfig()
  getConfig()
  setRequest()
  getRequest()
  setTitle()
  getTitle()
  canUseWikiPage()
  setWikiPage()
  getWikiPage()
  setOutput()
  getOutput()
  setUser()
  getUser()
  setLanguage()
  getLanguage()
  setSkin()
  getSkin()
  msg()


Class: DerivativeContext  - X-Ref

An IContextSource implementation which will inherit context from another source
but allow individual pieces of context to be changed locally
eg: A ContextSource that can inherit from the main RequestContext but have
a different Title instance set on it.

__construct( IContextSource $context )   X-Ref
Constructor

param: IContextSource $context Context to inherit from

setConfig( Config $s )   X-Ref
Set the SiteConfiguration object

param: Config $s

getConfig()   X-Ref
Get the Config object

return: Config

setRequest( WebRequest $r )   X-Ref
Set the WebRequest object

param: WebRequest $r

getRequest()   X-Ref
Get the WebRequest object

return: WebRequest

setTitle( Title $t )   X-Ref
Set the Title object

param: Title $t

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

setWikiPage( WikiPage $p )   X-Ref
Set the WikiPage object

param: WikiPage $p

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

setOutput( OutputPage $o )   X-Ref
Set the OutputPage object

param: OutputPage $o

getOutput()   X-Ref
Get the OutputPage object

return: OutputPage

setUser( User $u )   X-Ref
Set the User object

param: User $u

getUser()   X-Ref
Get the User object

return: User

setLanguage( $l )   X-Ref
Set the Language object

param: Language|string $l Language instance or language code

getLanguage()   X-Ref
Get the Language object

return: Language

setSkin( Skin $s )   X-Ref
Set the Skin object

param: Skin $s

getSkin()   X-Ref
Get the Skin object

return: Skin

msg()   X-Ref
Get a message using the current context.

This can't just inherit from ContextSource, since then
it would set only the original context, and not take
into account any changes.

param: mixed $args,... Arguments to wfMessage
return: Message



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