From Hexten

Contents 1 Synopsis 2 Interface 2.1 Argument Handling 2.1.1 arg($name, $default = null) 2.1.2 args() 2.1.3 need($name) 2.1.4 setDefaults($ar) 2.2 Configuration 2.2.1 config($name, $default = null) 2.2.2 needConfig($name) 2.3 Input 2.3.1 input() 2.3.2 inputDocument() 2.3.3 parseWikiMarkup($text) 2.3.4 parser() 2.4 Output 2.4.1 clearOutput() 2.4.2 disableCache() 2.4.3 getOutput() 2.4.4 output($str, ...) 2.5 Generating Markup 2.5.1 closeScript() 2.5.2 closeTag($name) 2.5.3 closedTag($name, $args = null) 2.5.4 endBox() 2.5.5 openScript() 2.5.6 openTag($name, $args = null) 2.5.7 startBox($caption, $type) 2.5.8 tag($name, $text, $args = null) 2.6 Widget Creation 2.6.1 bind($input, $argv, &$parser, &$info) 2.6.2 complete() 2.6.3 initialize() 2.7 Debugging 2.7.1 debug($str, ...) 2.7.2 debugDump($name, $val) 2.7.3 dumpArgs() 2.7.4 dumpOutput() 2.7.5 isDebug() 2.8 Utility 2.8.1 extensions() 2.8.2 fountain() 2.8.3 home() 2.8.4 makeURI($base, $args = null) 2.8.5 meta() 2.8.6 name() 2.8.7 title() 2.8.8 type() 2.8.9 widgetDir() 2.9 Rendering 2.9.1 render() 2.9.2 renderAbout() 2.9.3 renderContent() 2.9.4 renderDebug() 2.9.5 renderErrors($errs) 2.9.6 renderExample() 2.9.7 renderLinks($links) 2.10 Javascript Helpers 2.10.1 requireMyScript($name, $extra = "") 2.10.2 requireScript($src, $extra = "") 2.10.3 requireSupportScript() 2.10.4 script($src)

[edit] Synopsis

[edit] Interface

[edit] Argument Handling

[edit] arg($name, $default = null)

Get the value for the named argument.

[edit] args()

Get the Widget's argument array.

[edit] need($name)

Get the value of one of the Widget's arguments throwing an exception if the argument is undefined.

[edit] setDefaults($ar)

Set default values for arguments.

[edit] Configuration

[edit] config($name, $default = null)

Get a config item for this widget.

[edit] needConfig($name)

Get one of the Widget's configuration values throwing an exception if it is undefined.

[edit] Input

[edit] input()

Get the input string for the Widget.

[edit] inputDocument()

Parse the Widget's input as XML using Class DocumentParser.

[edit] parseWikiMarkup($text)

[edit] parser()

[edit] Output

[edit] clearOutput()

Clear the output buffer.

[edit] disableCache()

Disable MediaWiki's cache for this Widget. Use for Widgets that generate dynamic markup.

[edit] getOutput()

Get the contents of the output buffer and clear it.

[edit] output($str, ...)

Output one or more strings.

[edit] Generating Markup

[edit] closeScript()

Return a fragment of HTML that terminates inline JavaScript.

[edit] closeTag($name)

Return a string containing a closing HTML/XML tag.

[edit] closedTag($name, $args = null)

Return a closed XML / XHTML tag.

[edit] endBox()

Output the markup necessary to end a message box.

[edit] openScript()

Returns a fragment of HTML that starts an inline Javascript section.

[edit] openTag($name, $args = null)

Return an opening XML or HTML tag.

[edit] startBox($caption, $type)

[edit] tag($name, $text, $args = null)

[edit] Widget Creation

[edit] bind($input, $argv, &$parser, &$info)

Called to bind a Widget to its environment after loading.

[edit] complete()

Called to complete initialisation after binding.

[edit] initialize()

Called during Widget initialization.

[edit] Debugging

[edit] debug($str, ...)

Append to debug output. Does nothing if debug is disabled.

[edit] debugDump($name, $val)

Output a representation of a variable's value if debugging.

[edit] dumpArgs()

Add a dump of the Widget's args to the debug output.

[edit] dumpOutput()

Add a dump of the output buffer to debug.

[edit] isDebug()

Return true if we're in debug mode.

[edit] Utility

[edit] extensions()

Return the path to the wx home directory. Typically something like /wiki/extensions/wx.

[edit] fountain()

Return a new unique ID for this Widget.

[edit] home()

Return the path to the wiki. Typically something like /wiki.

[edit] makeURI($base, $args = null)

Build a URI by appending a number of arguments to a base URI.

[edit] meta()

Return the meta data array for this Widget.

[edit] name()

Return this Widget's human readable name.

[edit] title()

Get the title of the page containing this Widget.

[edit] type()

[edit] widgetDir()

[edit] Rendering

[edit] render()

Called by the framework to render the Widget.

[edit] renderAbout()

[edit] renderContent()

[edit] renderDebug()

[edit] renderErrors($errs)

[edit] renderExample()

[edit] renderLinks($links)

[edit] Javascript Helpers

[edit] requireMyScript($name, $extra = "")

[edit] requireScript($src, $extra = "")

[edit] requireSupportScript()

[edit] script($src)