summaryrefslogtreecommitdiff
path: root/docs/globals.txt
blob: ecc5ab33fdb13f61a5af270a6f816e2a0b956722 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
globals.txt

Globals are evil. The original MediaWiki code relied on
globals for processing context far too often. MediaWiki
development since then has been a story of slowly moving
context out of global variables and into objects. Storing
processing context in object member variables allows those
objects to be reused in a much more flexible way. Consider
the elegance of:

    # Generate the article HTML as if viewed by a web request
    $article = new Article( Title::newFromText( $t ) );
    $article->view();

versus

    # Save current globals
    $oldTitle = $wgTitle;
    $oldArticle = $wgArticle;

    # Generate the HTML
    $wgTitle = Title::newFromText( $t );
    $wgArticle = new Article;
    $wgArticle->view();

    # Restore globals
    $wgTitle = $oldTitle
    $wgArticle = $oldArticle

Some of the current MediaWiki developers have an idle
fantasy that some day, globals will be eliminated from
MediaWiki entirely, replaced by an application object which 
would be passed to constructors. Whether that would be an 
efficient, convenient solution remains to be seen, but 
certainly PHP 5 makes such object-oriented programming 
models easier than they were in previous versions.

For the time being though, MediaWiki programmers will have
to work in an environment with some global context. At the 
time of writing, 418 globals were initialised on startup by 
MediaWiki. 304 of these were configuration settings, which 
are documented in DefaultSettings.php. There is no 
comprehensive documentation for the remaining 114 globals, 
however some of the most important ones are listed below. 
They are typically initialised either in index.php or in 
Setup.php.


$wgOut
	OutputPage object for HTTP response.

$wgUser
	User object for the user associated with the current
	request.

$wgTitle
	Title object created from the request URL.

$wgLang
	Language object selected by user preferences

$wgContLang
	Language object associated with the wiki being
	viewed.

$wgArticle
	Article object corresponding to $wgTitle.

$wgParser
	Parser object. Parser extensions register their
	hooks here.

$wgLoadBalancer
	A LoadBalancer object, manages database connections.