<?php
/**
* @todo document
- * @addtogroup Parser
+ * @ingroup Parser
*/
class ParserOutput
{
$mNoGallery, # No gallery on category page? (__NOGALLERY__)
$mHeadItems, # Items to put in the <head> section
$mOutputHooks, # Hook tags as per $wgParserOutputHooks
- $mWarnings; # Warning text to be returned to the user. Wikitext formatted.
-
+ $mWarnings, # Warning text to be returned to the user. Wikitext formatted, in the key only
+ $mSections, # Table of contents
+ $mProperties; # Name/value pairs to be cached in the DB
+
/**
* Overridden title for display
*/
$this->mCacheTime = '';
$this->mVersion = Parser::VERSION;
$this->mTitleText = $titletext;
+ $this->mSections = array();
$this->mLinks = array();
$this->mTemplates = array();
$this->mImages = array();
$this->mTemplateIds = array();
$this->mOutputHooks = array();
$this->mWarnings = array();
+ $this->mProperties = array();
}
function getText() { return $this->mText; }
function &getCategories() { return $this->mCategories; }
function getCacheTime() { return $this->mCacheTime; }
function getTitleText() { return $this->mTitleText; }
+ function getSections() { return $this->mSections; }
function &getLinks() { return $this->mLinks; }
function &getTemplates() { return $this->mTemplates; }
function &getImages() { return $this->mImages; }
function getNoGallery() { return $this->mNoGallery; }
function getSubtitle() { return $this->mSubtitle; }
function getOutputHooks() { return (array)$this->mOutputHooks; }
- function getWarnings() { return isset( $this->mWarnings ) ? $this->mWarnings : array(); }
+ function getWarnings() { return array_keys( $this->mWarnings ); }
function containsOldMagic() { return $this->mContainsOldMagic; }
function setText( $text ) { return wfSetVar( $this->mText, $text ); }
function setCategoryLinks( $cl ) { return wfSetVar( $this->mCategories, $cl ); }
function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); }
function setCacheTime( $t ) { return wfSetVar( $this->mCacheTime, $t ); }
- function setTitleText( $t ) { return wfSetVar($this->mTitleText, $t); }
+ function setTitleText( $t ) { return wfSetVar( $this->mTitleText, $t ); }
+ function setSections( $toc ) { return wfSetVar( $this->mSections, $toc ); }
function addCategory( $c, $sort ) { $this->mCategories[$c] = $sort; }
function addLanguageLink( $t ) { $this->mLanguageLinks[] = $t; }
function addExternalLink( $url ) { $this->mExternalLinks[$url] = 1; }
- function addWarning( $s ) { $this->mWarnings[] = $s; }
+ function addWarning( $s ) { $this->mWarnings[$s] = 1; }
- function addOutputHook( $hook, $data = false ) {
+ function addOutputHook( $hook, $data = false ) {
$this->mOutputHooks[] = array( $hook, $data );
}
}
$this->mLinks[$ns][$dbk] = $id;
}
-
+
function addImage( $name ) {
$this->mImages[$name] = 1;
}
}
/**
- * Add some text to the <head>.
- * If $tag is set, the section with that tag will only be included once
+ * Add some text to the <head>.
+ * If $tag is set, the section with that tag will only be included once
* in a given page.
*/
function addHeadItem( $section, $tag = false ) {
$this->mHeadItems[] = $section;
}
}
-
+
/**
* Override the title to be used for display
* -- this is assumed to have been validated
public function setDisplayTitle( $text ) {
$this->displayTitle = $text;
}
-
+
/**
* Get the title to be used for display
*
public function getDisplayTitle() {
return $this->displayTitle;
}
-
+
/**
* Fairly generic flag setter thingy.
*/
public function setFlag( $flag ) {
$this->mFlags[$flag] = true;
}
-
+
public function getFlag( $flag ) {
return isset( $this->mFlags[$flag] );
}
-
-}
+ /**
+ * Set a property to be cached in the DB
+ */
+ public function setProperty( $name, $value ) {
+ $this->mProperties[$name] = $value;
+ }
+
+ public function getProperty( $name ){
+ return isset( $this->mProperties[$name] ) ? $this->mProperties[$name] : false;
+ }
+ public function getProperties() {
+ if ( !isset( $this->mProperties ) ) {
+ $this->mProperties = array();
+ }
+ return $this->mProperties;
+ }
+}