Inheritance diagram for ParserOutput:

Collaboration diagram for ParserOutput:

Public Member Functions
	__construct ($text= '', $languageLinks=array(), $categoryLinks=array(), $containsOldMagic=false, $titletext= '')
	addCategory ($c, $sort)
	addExternalLink ($url)
	addHeadItem ($section, $tag=false)
	Add some text to the "<head>".
	addImage ($name, $timestamp=null, $sha1=null)
	Register a file dependency for this output.
	addInterwikiLink ($title)
	addLanguageLink ($t)
	addLink ($title, $id=null)
	Record a local or interwiki inline link for saving in future link tables.
	addModuleMessages ($modules)
	addModules ($modules)
	addModuleScripts ($modules)
	addModuleStyles ($modules)
	addOutputHook ($hook, $data=false)
	addOutputPageMetadata (OutputPage $out)
	Copy items from the OutputPage object into this one.
	addSecondaryDataUpdate (DataUpdate $update)
	Adds an update job to the output.
	addTemplate ($title, $page_id, $rev_id)
	Register a template dependency for this output.
	addWarning ($s)
&	getCategories ()
	getCategoryLinks ()
	getDisplayTitle ()
	Get the title to be used for display.
	getEditSectionTokens ()
&	getExternalLinks ()
&	getFileSearchOptions ()
	getFlag ($flag)
	getHeadItems ()
	getHideNewSection ()
&	getImages ()
	getIndexPolicy ()
	getInterwikiLinks ()
&	getLanguageLinks ()
&	getLinks ()
	getModuleMessages ()
	getModules ()
	getModuleScripts ()
	getModuleStyles ()
	getNewSection ()
	getNoGallery ()
	getOutputHooks ()
	getProperties ()
	getProperty ($name)
	getSecondaryDataUpdates (Title $title=null, $recursive=true)
	Returns any DataUpdate jobs to be executed in order to store secondary information extracted from the page's content, including a LinksUpdate object for all links stored in this ParserOutput object.
	getSections ()
&	getTemplateIds ()
&	getTemplates ()
	getText ()
	getTimestamp ()
	getTitleText ()
	getTOCHTML ()
	getUsedOptions ()
	Returns the options from its ParserOptions which have been taken into account to produce this output or false if not available.
	getWarnings ()
	hideNewSection ($value)
	recordOption ($option)
	Callback passed by the Parser to the ParserOptions to keep track of which options are used.
	replaceEditSectionLinksCallback ($m)
	callback used by getText to replace editsection tokens
	setCategoryLinks ($cl)
	setDisplayTitle ($text)
	Override the title to be used for display.
	setEditSectionTokens ($t)
	setFlag ($flag)
	Fairly generic flag setter thingy.
	setIndexPolicy ($policy)
	setLanguageLinks ($ll)
	setNewSection ($value)
	setProperty ($name, $value)
	Set a property to be cached in the DB.
	setSections ($toc)
	setText ($text)
	setTimestamp ($timestamp)
	setTitleText ($t)
	setTOCHTML ($tochtml)
Public Attributes
	$mCategories
	$mEditSectionTokens = false
	$mExternalLinks = array()
	$mFileSearchOptions = array()
	$mHeadItems = array()
	$mHideNewSection = false
	$mImages = array()
	$mInterwikiLinks = array()
	$mLanguageLinks
	$mLinks = array()
	$mModuleMessages = array()
	$mModules = array()
	$mModuleScripts = array()
	$mModuleStyles = array()
	$mNewSection = false
	$mNoGallery = false
	$mOutputHooks = array()
	$mProperties = array()
	$mSections = array()
	$mTemplateIds = array()
	$mTemplates = array()
	$mText
	$mTimestamp
	$mTitleText
	$mTOCHTML = ''
	$mWarnings = array()
const	EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.?)" section="(.?)"(?:/>\|>(.*?)(</(?:mw:)?editsection>))#'
Private Attributes
	$mAccessedOptions = array()
	$mIndexPolicy = ''
	$mSecondaryDataUpdates = array()

Detailed Description

Definition at line 24 of file ParserOutput.php.

Constructor & Destructor Documentation

ParserOutput::__construct	(	$	text = `''`,
		$	languageLinks = `array()`,
		$	categoryLinks = `array()`,
		$	containsOldMagic = `false`,
		$	titletext = `''`
	)

Definition at line 57 of file ParserOutput.php.

Member Function Documentation

ParserOutput::addCategory	(	$	c,
		$	sort
	)

Definition at line 132 of file ParserOutput.php.

ParserOutput::addExternalLink ( $ url )

Definition at line 153 of file ParserOutput.php.

References $url.

ParserOutput::addHeadItem	(	$	section,
		$	tag = `false`
	)

Add some text to the "<head>".

If $tag is set, the section with that tag will only be included once in a given page.

Definition at line 248 of file ParserOutput.php.

References $section.

ParserOutput::addImage	(	$	name,
		$	timestamp = `null`,
		$	sha1 = `null`
	)

Register a file dependency for this output.

Parameters:

$name	string Title dbKey
$timestamp	string MW timestamp of file creation (or false if non-existing)
$sha1	string base 36 SHA-1 of file (or false if non-existing)

Returns:: void

Definition at line 201 of file ParserOutput.php.

ParserOutput::addInterwikiLink ( $ title )

Parameters:

$title Title object, must be an interwiki link

Exceptions:

MWException if given invalid input

Definition at line 232 of file ParserOutput.php.

References $title.

Referenced by addLink().

ParserOutput::addLanguageLink ( $ t )

Definition at line 133 of file ParserOutput.php.

References $t.

ParserOutput::addLink	(	$	title,
		$	id = `null`
	)

Record a local or interwiki inline link for saving in future link tables.

Parameters:

$title	Title object
$id	Mixed: optional known page_id so we can skip the lookup

Definition at line 166 of file ParserOutput.php.

References $title, and addInterwikiLink().

ParserOutput::addModuleMessages ( $ modules )

Definition at line 268 of file ParserOutput.php.

Referenced by addOutputPageMetadata().

ParserOutput::addModules ( $ modules )

Definition at line 256 of file ParserOutput.php.

Referenced by addOutputPageMetadata().

ParserOutput::addModuleScripts ( $ modules )

Definition at line 260 of file ParserOutput.php.

Referenced by addOutputPageMetadata().

ParserOutput::addModuleStyles ( $ modules )

Definition at line 264 of file ParserOutput.php.

Referenced by addOutputPageMetadata().

ParserOutput::addOutputHook	(	$	hook,
		$	data = `false`
	)

Definition at line 136 of file ParserOutput.php.

ParserOutput::addOutputPageMetadata ( OutputPage $ out )

Copy items from the OutputPage object into this one.

Parameters:

$out	OutputPage object

Definition at line 277 of file ParserOutput.php.

References addModuleMessages(), addModules(), addModuleScripts(), addModuleStyles(), OutputPage\getHeadItemsArray(), OutputPage\getModuleMessages(), OutputPage\getModules(), OutputPage\getModuleScripts(), and OutputPage\getModuleStyles().

ParserOutput::addSecondaryDataUpdate ( DataUpdate $ update )

Adds an update job to the output.

Any update jobs added to the output will eventually bexecuted in order to store any secondary information extracted from the page's content.

Since:: 1.20

Parameters:

DataUpdate $update

Definition at line 369 of file ParserOutput.php.

ParserOutput::addTemplate	(	$	title,
		$	page_id,
		$	rev_id
	)

Register a template dependency for this output.

Parameters:

$title	Title
$page_id
$rev_id

Returns:: void

Definition at line 215 of file ParserOutput.php.

References $title.

ParserOutput::addWarning ( $ s )

Definition at line 134 of file ParserOutput.php.

References $s.

& ParserOutput::getCategories ( )

Definition at line 99 of file ParserOutput.php.

ParserOutput::getCategoryLinks ( )

Definition at line 98 of file ParserOutput.php.

ParserOutput::getDisplayTitle ( )

Get the title to be used for display.

Returns:: String

Definition at line 303 of file ParserOutput.php.

References $t, and getTitleText().

ParserOutput::getEditSectionTokens ( )

Definition at line 102 of file ParserOutput.php.

& ParserOutput::getExternalLinks ( )

Definition at line 108 of file ParserOutput.php.

& ParserOutput::getFileSearchOptions ( )

Definition at line 107 of file ParserOutput.php.

ParserOutput::getFlag ( $ flag )

Definition at line 318 of file ParserOutput.php.

ParserOutput::getHeadItems ( )

Definition at line 110 of file ParserOutput.php.

ParserOutput::getHideNewSection ( )

Definition at line 146 of file ParserOutput.php.

& ParserOutput::getImages ( )

Definition at line 106 of file ParserOutput.php.

ParserOutput::getIndexPolicy ( )

Definition at line 117 of file ParserOutput.php.

ParserOutput::getInterwikiLinks ( )

Definition at line 97 of file ParserOutput.php.

& ParserOutput::getLanguageLinks ( )

Definition at line 96 of file ParserOutput.php.

& ParserOutput::getLinks ( )

Definition at line 103 of file ParserOutput.php.

ParserOutput::getModuleMessages ( )

Definition at line 114 of file ParserOutput.php.

ParserOutput::getModules ( )

Definition at line 111 of file ParserOutput.php.

ParserOutput::getModuleScripts ( )

Definition at line 112 of file ParserOutput.php.

ParserOutput::getModuleStyles ( )

Definition at line 113 of file ParserOutput.php.

ParserOutput::getNewSection ( )

Definition at line 149 of file ParserOutput.php.

ParserOutput::getNoGallery ( )

Definition at line 109 of file ParserOutput.php.

ParserOutput::getOutputHooks ( )

Definition at line 115 of file ParserOutput.php.

ParserOutput::getProperties ( )

Definition at line 333 of file ParserOutput.php.

ParserOutput::getProperty ( $ name )

Definition at line 329 of file ParserOutput.php.

ParserOutput::getSecondaryDataUpdates	(	Title $	title = `null`,
		$	recursive = `true`
	)

Returns any DataUpdate jobs to be executed in order to store secondary information extracted from the page's content, including a LinksUpdate object for all links stored in this ParserOutput object.

Since:: 1.20

Parameters:

$title	Title of the page we're updating. If not given, a title object will be created based on $this->getTitleText()
$recursive	Boolean: queue jobs for recursive updates?

Returns:: Array. An array of instances of DataUpdate

Definition at line 385 of file ParserOutput.php.

References $title, getTitleText(), and Title\newFromText().

ParserOutput::getSections ( )

Definition at line 101 of file ParserOutput.php.

& ParserOutput::getTemplateIds ( )

Definition at line 105 of file ParserOutput.php.

& ParserOutput::getTemplates ( )

Definition at line 104 of file ParserOutput.php.

ParserOutput::getText ( )

Definition at line 67 of file ParserOutput.php.

References EDITSECTION_REGEX.

ParserOutput::getTimestamp ( )

Definition at line 119 of file ParserOutput.php.

ParserOutput::getTitleText ( )

Definition at line 100 of file ParserOutput.php.

Referenced by getDisplayTitle(), and getSecondaryDataUpdates().

ParserOutput::getTOCHTML ( )

Definition at line 118 of file ParserOutput.php.

ParserOutput::getUsedOptions ( )

Returns the options from its ParserOptions which have been taken into account to produce this output or false if not available.

Returns:: mixed Array

Definition at line 346 of file ParserOutput.php.

ParserOutput::getWarnings ( )

Definition at line 116 of file ParserOutput.php.

ParserOutput::hideNewSection ( $ value )

Definition at line 143 of file ParserOutput.php.

References $value.

ParserOutput::recordOption ( $ option )

Callback passed by the Parser to the ParserOptions to keep track of which options are used.

Access:: private

Definition at line 357 of file ParserOutput.php.

ParserOutput::replaceEditSectionLinksCallback ( $ m )

callback used by getText to replace editsection tokens

Access:: private

Returns:: mixed

Definition at line 80 of file ParserOutput.php.

References $wgLang, $wgOut, and Title\newFromText().

ParserOutput::setCategoryLinks ( $ cl )

Definition at line 123 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setDisplayTitle ( $ text )

Override the title to be used for display.

-- this is assumed to have been validated (check equal normalisation, etc.)

Parameters:

$text String: desired title text

Definition at line 293 of file ParserOutput.php.

References setProperty(), and setTitleText().

ParserOutput::setEditSectionTokens ( $ t )

Definition at line 127 of file ParserOutput.php.

References $t, and wfSetVar().

ParserOutput::setFlag ( $ flag )

Fairly generic flag setter thingy.

Definition at line 314 of file ParserOutput.php.

ParserOutput::setIndexPolicy ( $ policy )

Definition at line 128 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setLanguageLinks ( $ ll )

Definition at line 122 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setNewSection ( $ value )

Definition at line 140 of file ParserOutput.php.

References $value.

ParserOutput::setProperty	(	$	name,
		$	value
	)

Set a property to be cached in the DB.

Definition at line 325 of file ParserOutput.php.

References $value.

Referenced by setDisplayTitle().

ParserOutput::setSections ( $ toc )

Definition at line 126 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setText ( $ text )

Definition at line 121 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setTimestamp ( $ timestamp )

Definition at line 130 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setTitleText ( $ t )

Definition at line 125 of file ParserOutput.php.

References $t, and wfSetVar().

Referenced by setDisplayTitle().

ParserOutput::setTOCHTML ( $ tochtml )

Definition at line 129 of file ParserOutput.php.

References wfSetVar().

Member Data Documentation

ParserOutput::$mAccessedOptions = array() [private]

Definition at line 52 of file ParserOutput.php.

ParserOutput::$mCategories

Definition at line 25 of file ParserOutput.php.

ParserOutput::$mEditSectionTokens = false

Definition at line 47 of file ParserOutput.php.

ParserOutput::$mExternalLinks = array()

Definition at line 34 of file ParserOutput.php.

ParserOutput::$mFileSearchOptions = array()

Definition at line 33 of file ParserOutput.php.

ParserOutput::$mHeadItems = array()

Definition at line 39 of file ParserOutput.php.

ParserOutput::$mHideNewSection = false

Definition at line 37 of file ParserOutput.php.

ParserOutput::$mImages = array()

Definition at line 32 of file ParserOutput.php.

ParserOutput::$mIndexPolicy = '' [private]

Definition at line 51 of file ParserOutput.php.

ParserOutput::$mInterwikiLinks = array()

Definition at line 35 of file ParserOutput.php.

ParserOutput::$mLanguageLinks

Definition at line 25 of file ParserOutput.php.

ParserOutput::$mLinks = array()

Definition at line 29 of file ParserOutput.php.

ParserOutput::$mModuleMessages = array()

Definition at line 43 of file ParserOutput.php.

ParserOutput::$mModules = array()

Definition at line 40 of file ParserOutput.php.

ParserOutput::$mModuleScripts = array()

Definition at line 41 of file ParserOutput.php.

ParserOutput::$mModuleStyles = array()

Definition at line 42 of file ParserOutput.php.

ParserOutput::$mNewSection = false

Definition at line 36 of file ParserOutput.php.

ParserOutput::$mNoGallery = false

Definition at line 38 of file ParserOutput.php.

ParserOutput::$mOutputHooks = array()

Definition at line 44 of file ParserOutput.php.

ParserOutput::$mProperties = array()

Definition at line 48 of file ParserOutput.php.

ParserOutput::$mSecondaryDataUpdates = array() [private]

Definition at line 53 of file ParserOutput.php.

ParserOutput::$mSections = array()

Definition at line 46 of file ParserOutput.php.

ParserOutput::$mTemplateIds = array()

Definition at line 31 of file ParserOutput.php.

ParserOutput::$mTemplates = array()

Definition at line 30 of file ParserOutput.php.

ParserOutput::$mText

Definition at line 25 of file ParserOutput.php.

ParserOutput::$mTimestamp

Definition at line 49 of file ParserOutput.php.

ParserOutput::$mTitleText

Definition at line 25 of file ParserOutput.php.

ParserOutput::$mTOCHTML = ''

Definition at line 49 of file ParserOutput.php.

ParserOutput::$mWarnings = array()

Definition at line 45 of file ParserOutput.php.

const ParserOutput::EDITSECTION_REGEX = '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#'

Definition at line 55 of file ParserOutput.php.

Referenced by getText().

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

includes/parser/ParserOutput.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation