Packages:
Text_Wiki
Text_Wiki_Docbook

Classes:

Files:

Address.php
Anchor.php
Anchor.php
Anchor.php
Anchor.php
Blockquote.php
Blockquote.php
Blockquote.php
Blockquote.php
Bold.php
Bold.php
Bold.php
Bold.php
Box.php
Box.php
Box.php
Break.php
Break.php
Break.php
Break.php
Center.php
Center.php
Center.php
Center.php
Code.php
Code.php
Code.php
Code.php
Colortext.php
Colortext.php
Colortext.php
Colortext.php
Default.php
Deflist.php
Deflist.php
Deflist.php
Deflist.php
Delimiter.php
Delimiter.php
Delimiter.php
Delimiter.php
Embed.php
Embed.php
Embed.php
Embed.php
Emphasis.php
Emphasis.php
Emphasis.php
Emphasis.php
Font.php
Font.php
Font.php
Freelink.php
Freelink.php
Freelink.php
Freelink.php
Function.php
Function.php
Function.php
Function.php
Heading.php
Heading.php
Heading.php
Heading.php
Horiz.php
Horiz.php
Horiz.php
Horiz.php
Html.php
Html.php
Html.php
Html.php
Image.php
Image.php
Image.php
Image.php
Include.php
Include.php
Include.php
Include.php
Interwiki.php
Interwiki.php
Interwiki.php
Interwiki.php
Italic.php
Italic.php
Italic.php
Italic.php
Latex.php
List.php
List.php
List.php
List.php
Newline.php
Newline.php
Newline.php
Newline.php
Page.php
Page.php
Page.php
Paragraph.php
Paragraph.php
Paragraph.php
Paragraph.php
Parse.php
parser.php
Phplookup.php
Phplookup.php
Phplookup.php
Phplookup.php
Plain.php
Plugin.php
Plugin.php
Plugin.php
Prefilter.php
Prefilter.php
Prefilter.php
Prefilter.php
Preformatted.php
Preformatted.php
Preformatted.php
Raw.php
Raw.php
Raw.php
Raw.php
Render.php
Revise.php
Revise.php
Revise.php
Revise.php
Smiley.php
Smiley.php
Smiley.php
Smiley.php
Specialchar.php
Specialchar.php
Specialchar.php
Strong.php
Strong.php
Strong.php
Strong.php
Subscript.php
Subscript.php
Subscript.php
Subscript.php
Superscript.php
Superscript.php
Superscript.php
Superscript.php
Table.php
Table.php
Table.php
Table.php
test_Text_Wiki.php
Tighten.php
Tighten.php
Tighten.php
Tighten.php
Titlebar.php
Titlebar.php
Titlebar.php
Toc.php
Toc.php
Toc.php
Toc.php
Tt.php
Tt.php
Tt.php
Tt.php
Underline.php
Underline.php
Underline.php
Underline.php
Url.php
Url.php
Url.php
Url.php
Wiki.php
Wikilink.php
Wikilink.php
Wikilink.php
Wikilink.php
Xhtml.php

Class: Text_Wiki_Render_Xhtml_Function

Source Location: /Text_Wiki-1.2.4/Text/Wiki/Render/Xhtml/Function.php

Class Overview

Text_Wiki_Render
   |
   --Text_Wiki_Render_Xhtml_Function

This class renders a function description in XHTML.

Author(s):

Paul M. Jones <pmjones at php.net>

Version:

Release: @package_version@

Variables

$conf

Methods

token

Inherited Variables

Class: Text_Wiki_Render

Text_Wiki_Render::$format
Text_Wiki_Render::$rule
Text_Wiki_Render::$wiki

Inherited Methods

Class: Text_Wiki_Render

Text_Wiki_Render::__construct(): Constructor for this render format or rule.
Text_Wiki_Render::Text_Wiki_Render(): Constructor for this render format or rule.
Text_Wiki_Render::formatConf(): Simple method to wrap a configuration in an sprintf() format.
Text_Wiki_Render::getConf(): Simple method to safely get configuration key values.
Text_Wiki_Render::textEncode(): Default method to render text (htmlspecialchars)
Text_Wiki_Render::urlEncode(): Default method to render url

Class Details

[line 26]
This class renders a function description in XHTML.

Author: Paul M. Jones <pmjones@php.net>
Version: Release: @package_version@
Link: http://pear.php.net/package/Text_Wiki
License: LGPL License 2.1

[ Top ]

Class Variables

$conf = array(
 // list separator for params and throws
 'list_sep' => ', ',

 // the "main" format string
 'format_main' => '%access %return %name ( %params ) %throws',

 // the looped format string for required params
 'format_param' => '%type %descr',

 // the looped format string for params with default values
 'format_paramd' => '[%type %descr default %default]',

 // the looped format string for throws
 'format_throws' => 'throws %type %descr'
 )

[line 28]

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

token [line 58]

string token(
array
$options)

Renders a token into text matching the requested format.

Return: The text rendered from the token options.
Access: public

Parameters:

array $options — The "options" portion of the token (second element).

[ Top ]