Class: PluginContentsx

Source Location: /contentsx.inc.php

Class PluginContentsx

Class Overview

Table of Contents Plugin

Author(s):

sonots <http://lsx.osdn.jp>

Information Tags:

Version:	$Id: contentsx.inc.php,v 2.0 2008-07-15 11:14:46 sonots $
Link:	http://lsx.osdn.jp/?Plugin%2Fcontentsx.inc.php
License:	GPL

Properties

Methods

[ Top ]

Property Summary

mixed	$conf
mixed	$conf_options
mixed	$plugin

[ Top ]

Method Summary

PluginContentsx	PluginContentsx()
void	action()	Action Plugin Main Function
$options	check_options()	Check validity and compatibility of options
$options	check_page()	Check validity of page
void	clean_cache()	Clean Table of Contents Cache Files
void	convert()	Block Plugin Main Function
string	display_toc()	Display Table of Contents

[ Top ]

Properties

mixed $conf [line 57]

[ Top ]

mixed $conf_options [line 58]

[ Top ]

mixed $plugin = "contentsx" [line 59]

[ Top ]

Methods

Constructor PluginContentsx [line 24]

PluginContentsx PluginContentsx(
)

[ Top ]

action [line 209]

void action(
)

Action Plugin Main Function

[ Top ]

check_options [line 127]

$options check_options(
string
$page, string
$current, array
$options, [array
$unknowns = array()] 
)

Check validity and compatibility of options

Parameters:

string	$page:	name to get contents
string	$current:	showing page name
array	$options:
array	$unknowns:

[ Top ]

check_page [line 104]

$options check_page(
string
$page, 
$current, array
$options 
)

Check validity of page

Parameters:

string	$page:
array	$options:
	$current:

[ Top ]

clean_cache [line 227]

void clean_cache(
)

Clean Table of Contents Cache Files

[ Top ]

convert [line 65]

void convert(
)

Block Plugin Main Function

[ Top ]

display_toc [line 156]

string display_toc(
string
$page, array
$options 
)

Display Table of Contents

Parameters:

string	$page:
array	$options:

API Tags:

Return:

html

[ Top ]

Documentation generated on Sat, 16 Aug 2008 15:27:24 -0400 by phpDocumentor 1.3.2

	plugin

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