German localisation updates, patch by ray.
[lhc/web/wiklou.git] / includes / ParserOutput.php
index ba9db73..7117f71 100644 (file)
@@ -17,11 +17,18 @@ class ParserOutput
                $mTemplateIds,      # 2-D map of NS/DBK to rev ID for the template references. ID=zero for broken.
                $mImages,           # DB keys of the images used, in the array key only
                $mExternalLinks,    # External link URLs, in the key only
-               $mHTMLtitle,        # Display HTML title
-               $mSubtitle,         # Additional subtitle
                $mNewSection,       # Show a new section link?
                $mNoGallery,        # No gallery on category page? (__NOGALLERY__)
-               $mHeadItems;        # Items to put in the <head> section
+               $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.
+               $mSections,         # Table of contents
+               $mProperties;       # Name/value pairs to be cached in the DB
+
+       /**
+        * Overridden title for display
+        */
+       private $displayTitle = false;
 
        function ParserOutput( $text = '', $languageLinks = array(), $categoryLinks = array(),
                $containsOldMagic = false, $titletext = '' )
@@ -33,16 +40,18 @@ class ParserOutput
                $this->mCacheTime = '';
                $this->mVersion = Parser::VERSION;
                $this->mTitleText = $titletext;
+               $this->mSections = array();
                $this->mLinks = array();
                $this->mTemplates = array();
                $this->mImages = array();
                $this->mExternalLinks = array();
-               $this->mHTMLtitle = "" ;
-               $this->mSubtitle = "" ;
                $this->mNewSection = false;
                $this->mNoGallery = false;
                $this->mHeadItems = array();
                $this->mTemplateIds = array();
+               $this->mOutputHooks = array();
+               $this->mWarnings = array();
+               $this->mProperties = array();
        }
 
        function getText()                   { return $this->mText; }
@@ -51,12 +60,15 @@ class ParserOutput
        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 &getExternalLinks()         { return $this->mExternalLinks; }
        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 containsOldMagic()          { return $this->mContainsOldMagic; }
        function setText( $text )            { return wfSetVar( $this->mText, $text ); }
@@ -64,12 +76,17 @@ class ParserOutput
        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 setSubtitle( $st )          { return wfSetVar( $this->mSubtitle, $st ); }
+       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 addOutputHook( $hook, $data = false ) {
+               $this->mOutputHooks[] = array( $hook, $data );
+       }
 
        function setNewSection( $value ) {
                $this->mNewSection = (bool)$value;
@@ -89,7 +106,7 @@ class ParserOutput
                }
                $this->mLinks[$ns][$dbk] = $id;
        }
-       
+
        function addImage( $name ) {
                $this->mImages[$name] = 1;
        }
@@ -126,8 +143,8 @@ class ParserOutput
        }
 
        /**
-        * 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 ) {
@@ -137,6 +154,53 @@ class ParserOutput
                        $this->mHeadItems[] = $section;
                }
        }
-}
 
-?>
+       /**
+        * Override the title to be used for display
+        * -- this is assumed to have been validated
+        * (check equal normalisation, etc.)
+        *
+        * @param string $text Desired title text
+        */
+       public function setDisplayTitle( $text ) {
+               $this->displayTitle = $text;
+       }
+
+       /**
+        * Get the title to be used for display
+        *
+        * @return string
+        */
+       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;
+       }
+}