ParserOutput Class Reference
[Parser]

List of all members.

Public Member Functions

 ParserOutput ($text= '', $languageLinks=array(), $categoryLinks=array(), $containsOldMagic=false, $titletext= '')
 getText ()
getLanguageLinks ()
 getCategoryLinks ()
getCategories ()
 getCacheTime ()
 getTitleText ()
 getSections ()
getLinks ()
getTemplates ()
getImages ()
getExternalLinks ()
 getNoGallery ()
 getHeadItems ()
 getSubtitle ()
 getOutputHooks ()
 getWarnings ()
 getIndexPolicy ()
 getTOCHTML ()
 containsOldMagic ()
 setText ($text)
 setLanguageLinks ($ll)
 setCategoryLinks ($cl)
 setContainsOldMagic ($com)
 setCacheTime ($t)
 setTitleText ($t)
 setSections ($toc)
 setIndexPolicy ($policy)
 setTOCHTML ($tochtml)
 addCategory ($c, $sort)
 addLanguageLink ($t)
 addWarning ($s)
 addOutputHook ($hook, $data=false)
 setNewSection ($value)
 hideNewSection ($value)
 getHideNewSection ()
 getNewSection ()
 addExternalLink ($url)
 addLink ($title, $id=null)
 addImage ($name)
 addTemplate ($title, $page_id, $rev_id)
 expired ($touched)
 Return true if this cached output object predates the global or per-article cache invalidation timestamps, or if it comes from an incompatible older version.
 addHeadItem ($section, $tag=false)
 Add some text to the <head>.
 setDisplayTitle ($text)
 Override the title to be used for display -- this is assumed to have been validated (check equal normalisation, etc.
 getDisplayTitle ()
 Get the title to be used for display.
 setFlag ($flag)
 Fairly generic flag setter thingy.
 getFlag ($flag)
 setProperty ($name, $value)
 Set a property to be cached in the DB.
 getProperty ($name)
 getProperties ()

Public Attributes

 $mText
 $mLanguageLinks
 $mCategories
 $mContainsOldMagic
 $mTitleText
 $mCacheTime = ''
 $mVersion = Parser::VERSION
 $mLinks = array()
 $mTemplates = array()
 $mTemplateIds = array()
 $mImages = array()
 $mExternalLinks = array()
 $mNewSection = false
 $mHideNewSection = false
 $mNoGallery = false
 $mHeadItems = array()
 $mOutputHooks = array()
 $mWarnings = array()
 $mSections = array()
 $mProperties = array()
 $mTOCHTML = ''

Private Attributes

 $mIndexPolicy = ''


Detailed Description

Todo:
document

Definition at line 6 of file ParserOutput.php.


Member Function Documentation

ParserOutput::addCategory ( c,
sort 
)

Definition at line 71 of file ParserOutput.php.

ParserOutput::addExternalLink ( url  ) 

Definition at line 92 of file ParserOutput.php.

References $url, $wgRegisterInternalExternals, and $wgServer.

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 166 of file ParserOutput.php.

References $section.

ParserOutput::addImage ( name  ) 

Definition at line 126 of file ParserOutput.php.

References $name.

ParserOutput::addLanguageLink ( t  ) 

Definition at line 72 of file ParserOutput.php.

References $t.

ParserOutput::addLink ( title,
id = null 
)

Definition at line 99 of file ParserOutput.php.

References $title.

ParserOutput::addOutputHook ( hook,
data = false 
)

Definition at line 75 of file ParserOutput.php.

ParserOutput::addTemplate ( title,
page_id,
rev_id 
)

Definition at line 130 of file ParserOutput.php.

References $title.

ParserOutput::addWarning ( s  ) 

Definition at line 73 of file ParserOutput.php.

References $s.

ParserOutput::containsOldMagic (  ) 

Definition at line 60 of file ParserOutput.php.

ParserOutput::expired ( touched  ) 

Return true if this cached output object predates the global or per-article cache invalidation timestamps, or if it comes from an incompatible older version.

Parameters:
string $touched the affected article's last touched timestamp
Returns:
bool
Access:
public

Definition at line 152 of file ParserOutput.php.

References $wgCacheEpoch, getCacheTime(), and Parser::VERSION.

ParserOutput::getCacheTime (  ) 

Definition at line 45 of file ParserOutput.php.

Referenced by expired().

& ParserOutput::getCategories (  ) 

Definition at line 44 of file ParserOutput.php.

ParserOutput::getCategoryLinks (  ) 

Definition at line 43 of file ParserOutput.php.

ParserOutput::getDisplayTitle (  ) 

Get the title to be used for display.

Returns:
string

Definition at line 190 of file ParserOutput.php.

References $t, and getTitleText().

& ParserOutput::getExternalLinks (  ) 

Definition at line 51 of file ParserOutput.php.

ParserOutput::getFlag ( flag  ) 

Definition at line 205 of file ParserOutput.php.

ParserOutput::getHeadItems (  ) 

Definition at line 53 of file ParserOutput.php.

ParserOutput::getHideNewSection (  ) 

Definition at line 85 of file ParserOutput.php.

& ParserOutput::getImages (  ) 

Definition at line 50 of file ParserOutput.php.

ParserOutput::getIndexPolicy (  ) 

Definition at line 57 of file ParserOutput.php.

& ParserOutput::getLanguageLinks (  ) 

Definition at line 42 of file ParserOutput.php.

& ParserOutput::getLinks (  ) 

Definition at line 48 of file ParserOutput.php.

ParserOutput::getNewSection (  ) 

Definition at line 88 of file ParserOutput.php.

ParserOutput::getNoGallery (  ) 

Definition at line 52 of file ParserOutput.php.

ParserOutput::getOutputHooks (  ) 

Definition at line 55 of file ParserOutput.php.

ParserOutput::getProperties (  ) 

Definition at line 220 of file ParserOutput.php.

ParserOutput::getProperty ( name  ) 

Definition at line 216 of file ParserOutput.php.

References $name.

ParserOutput::getSections (  ) 

Definition at line 47 of file ParserOutput.php.

ParserOutput::getSubtitle (  ) 

Definition at line 54 of file ParserOutput.php.

& ParserOutput::getTemplates (  ) 

Definition at line 49 of file ParserOutput.php.

ParserOutput::getText (  ) 

Definition at line 41 of file ParserOutput.php.

ParserOutput::getTitleText (  ) 

Definition at line 46 of file ParserOutput.php.

Referenced by getDisplayTitle().

ParserOutput::getTOCHTML (  ) 

Definition at line 58 of file ParserOutput.php.

ParserOutput::getWarnings (  ) 

Definition at line 56 of file ParserOutput.php.

ParserOutput::hideNewSection ( value  ) 

Definition at line 82 of file ParserOutput.php.

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

Definition at line 31 of file ParserOutput.php.

ParserOutput::setCacheTime ( t  ) 

Definition at line 65 of file ParserOutput.php.

References $t, and wfSetVar().

ParserOutput::setCategoryLinks ( cl  ) 

Definition at line 63 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setContainsOldMagic ( com  ) 

Definition at line 64 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:
string $text Desired title text

Definition at line 181 of file ParserOutput.php.

References setTitleText().

ParserOutput::setFlag ( flag  ) 

Fairly generic flag setter thingy.

Definition at line 201 of file ParserOutput.php.

ParserOutput::setIndexPolicy ( policy  ) 

Definition at line 68 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setLanguageLinks ( ll  ) 

Definition at line 62 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setNewSection ( value  ) 

Definition at line 79 of file ParserOutput.php.

ParserOutput::setProperty ( name,
value 
)

Set a property to be cached in the DB.

Definition at line 212 of file ParserOutput.php.

References $name.

ParserOutput::setSections ( toc  ) 

Definition at line 67 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setText ( text  ) 

Definition at line 61 of file ParserOutput.php.

References wfSetVar().

ParserOutput::setTitleText ( t  ) 

Definition at line 66 of file ParserOutput.php.

References $t, and wfSetVar().

Referenced by setDisplayTitle().

ParserOutput::setTOCHTML ( tochtml  ) 

Definition at line 69 of file ParserOutput.php.

References wfSetVar().


Member Data Documentation

ParserOutput::$mCacheTime = ''

Definition at line 13 of file ParserOutput.php.

ParserOutput::$mCategories

Definition at line 8 of file ParserOutput.php.

ParserOutput::$mContainsOldMagic

Definition at line 8 of file ParserOutput.php.

ParserOutput::$mExternalLinks = array()

Definition at line 19 of file ParserOutput.php.

ParserOutput::$mHeadItems = array()

Definition at line 23 of file ParserOutput.php.

ParserOutput::$mHideNewSection = false

Definition at line 21 of file ParserOutput.php.

ParserOutput::$mImages = array()

Definition at line 18 of file ParserOutput.php.

ParserOutput::$mIndexPolicy = '' [private]

Definition at line 29 of file ParserOutput.php.

ParserOutput::$mLanguageLinks

Definition at line 8 of file ParserOutput.php.

ParserOutput::$mLinks = array()

Definition at line 15 of file ParserOutput.php.

ParserOutput::$mNewSection = false

Definition at line 20 of file ParserOutput.php.

ParserOutput::$mNoGallery = false

Definition at line 22 of file ParserOutput.php.

ParserOutput::$mOutputHooks = array()

Definition at line 24 of file ParserOutput.php.

ParserOutput::$mProperties = array()

Definition at line 27 of file ParserOutput.php.

ParserOutput::$mSections = array()

Definition at line 26 of file ParserOutput.php.

ParserOutput::$mTemplateIds = array()

Definition at line 17 of file ParserOutput.php.

ParserOutput::$mTemplates = array()

Definition at line 16 of file ParserOutput.php.

ParserOutput::$mText

Definition at line 8 of file ParserOutput.php.

ParserOutput::$mTitleText

Definition at line 8 of file ParserOutput.php.

ParserOutput::$mTOCHTML = ''

Definition at line 28 of file ParserOutput.php.

ParserOutput::$mVersion = Parser::VERSION

Definition at line 14 of file ParserOutput.php.

ParserOutput::$mWarnings = array()

Definition at line 25 of file ParserOutput.php.


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

Generated on Sat Apr 30 22:57:45 2011 for MediaWiki by  doxygen 1.5.9