Text_Wiki
[ class tree: Text_Wiki ] [ index: Text_Wiki ] [ all elements ]

Class: Text_Wiki_Render_Xhtml_Toc

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

Class Overview

Text_Wiki_Render
   |
   --Text_Wiki_Render_Xhtml_Toc

This class inserts a table of content in XHTML.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

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 inserts a table of content in XHTML.


[ Top ]


Class Variables

$conf = array(
        'css_list' => null,
        'css_item' => null,
        'title' => '<strong>Table of Contents</strong>',
        'div_id' => 'toc',
        'base_url' => '',
        'collapse' => true
    )

[line 28]


Type:   mixed
Overrides:   Array


[ Top ]

$min =  2

[line 37]


Type:   mixed


[ Top ]



Method Detail

token   [line 52]

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 ]


Documentation generated on Tue, 12 Mar 2019 21:49:22 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.