Class: PluginWikinote

Source Location: /wikinote.inc.php

Class PluginWikinote

Class Overview

Wikipedia-like Note(Discussion) Plugin

Author(s):

sonots

Information Tags:

Version:	$Id: wikinote.inc.php,v 1.8 2007-12-21 16:28:39Z sonots $
Link:	http://lsx.osdn.jp/?Plugin%2Fwikinote.inc.php
License:	GPL v2

Properties

Methods

[ Top ]

Property Summary

mixed	$allowed_plugin
mixed	$default_def_void
mixed	$default_options
mixed	$default_template_contents
mixed	$def_void
mixed	$def_wikinote
mixed	$error
mixed	$options
mixed	$plugin

[ Top ]

Method Summary

PluginWikinote	PluginWikinote()
void	autocreate_notepage()	Create a wikinote page automatically
void	autocreate_wikinote()	Obsolete: Use autocreate_notepage
string	get_mainpagename()	Get mainpage name from notepage name
array(string,	get_mainpage_notepage()	Get mainpage (article) and notepage (discuss) pair from a pagename
string	get_notepagename()	Get notepage name from mainpage name
string	get_title()	Get a page title
void	is_effect()	Check if wikinote is effective for the page or not
boolean	is_notepage()	Check if a page is a notepage
void	is_valid()	Obsolete: Use is_effect
void	is_wikinote()	Obsolete: Use is_notepage
void	show_links()	Obolete: Use show_tabs
void	show_tabs()	Show tabs (ul list)
string	show_template_html()	Get a modified template html
string	_replace_form()	Replace a form html POST into ?cmd=wikinote (Callback function)

[ Top ]

Properties

mixed $allowed_plugin [line 24]

[ Top ]

mixed $default_def_void [line 16]

[ Top ]

mixed $default_options [line 15]

[ Top ]

mixed $default_template_contents = "#comment\n" [line 23]

[ Top ]

mixed $def_void [line 22]

[ Top ]

mixed $def_wikinote [line 21]

[ Top ]

mixed $error = '' [line 18]

[ Top ]

mixed $options [line 20]

[ Top ]

mixed $plugin = 'wikinote' [line 19]

[ Top ]

Methods

Constructor PluginWikinote [line 26]

PluginWikinote PluginWikinote(
)

[ Top ]

autocreate_notepage [line 225]

void autocreate_notepage(
[string
$page = ''], boolean
1 
)

Create a wikinote page automatically

Parameters:

string	$page:
boolean	1:	created or not

[ Top ]

autocreate_wikinote [line 280]

void autocreate_wikinote(
[
$page = ''] 
)

Obsolete: Use autocreate_notepage

Parameters:

$page:

API Tags:

See:

PluginWikinote::autocreate_notepage()

[ Top ]

get_mainpagename [line 212]

string get_mainpagename(
string
$notepage 
)

Get mainpage name from notepage name

Parameters:

string

$notepage:

API Tags:

Return:

mainpage

[ Top ]

get_mainpage_notepage [line 183]

array(string, get_mainpage_notepage(
string
$page 
)

Get mainpage (article) and notepage (discuss) pair from a pagename

Parameters:

string

$page:

API Tags:

Return:

string)

[ Top ]

get_notepagename [line 201]

string get_notepagename(
string
$mainpage 
)

Get notepage name from mainpage name

Parameters:

string

$mainpage:

API Tags:

Return:

notepage

[ Top ]

get_title [line 334]

string get_title(
string
$page 
)

Get a page title

Parameters:

string

$page:

Page name

API Tags:

Return:

page title

[ Top ]

is_effect [line 85]

void is_effect(
[string
$page = ''] 
)

Check if wikinote is effective for the page or not

Parameters:

string

$page:

pagename

API Tags:

Global:

array $vars: vars['page'] for the default page

[ Top ]

is_notepage [line 166]

boolean is_notepage(
[string
$page = ''] 
)

Check if a page is a notepage

Parameters:

string

$page:

API Tags:

Global:

array $vars: vars['page'] for the default page

[ Top ]

is_valid [line 249]

void is_valid(
[
$page = ''] 
)

Obsolete: Use is_effect

Parameters:

$page:

API Tags:

See:

PluginWikinote::is_effect()

[ Top ]

is_wikinote [line 271]

void is_wikinote(
[
$page = ''] 
)

Obsolete: Use is_notepage

Parameters:

$page:

API Tags:

See:

PluginWikinote::is_notepage()

[ Top ]

show_links [line 258]

void show_links(
[
$cmds = array('main' => 'Article', 'note' => 'Comment')], [
$page = ''] 
)

Obolete: Use show_tabs

Parameters:

	$cmds:
	$page:

API Tags:

See:

PluginWikinote::show_tabs()

[ Top ]

show_tabs [line 115]

void show_tabs(
[array
$tabs = array(
                         array('cmd'=>'main', 'label'=>'Article'),array('cmd'=>'note','label'=>'Comment'),array('cmd'=>'edit','label'=>'Edit','href'=>'?cmd=edit&amp;page=$page'),array('cmd'=>'diff','label'=>'Diff','href'=>'?cmd=diff&amp;page=$page'),)], [string
$page = ''] 
)

Show tabs (ul list)

Parameters:

array	$tabs:	array of array('cmd'=>,'label'=>,'href'=>) 'cmd' is a PukiWiki cmd such as 'edit' or 'diff', additionally 'main' for mainpage and 'note' for notepage 'label' is a string to be shown on the tab (link). It could be an img tag. Default: 'cmd' word. 'href' is a link href. Ex) 'href'=>'?cmd=diff&page=$page. Reserved words: $page => PageName. Default: Guessed from 'cmd'.
string	$page:	$vars['page'] is used if not specified.

[ Top ]

show_template_html [line 291]

string show_template_html(
string
$page 
)

Get a modified template html

Parameters:

string

$page:

Page name

API Tags:

Return:

html

[ Top ]

_replace_form [line 310]

string _replace_form(
string
$form 
)

Replace a form html POST into ?cmd=wikinote (Callback function)

Parameters:

string

$form:

form html

API Tags:

Return:

modified html

Information Tags:

Private:

[ Top ]

Documentation generated on Fri, 21 Dec 2007 06:58:01 -0500 by phpDocumentor 1.3.2

	plugin

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