page_wiki Class Reference

Class page_wiki contains the common code between all pages. More...

Inheritance diagram for page_wiki:

Public Member Functions
	__construct ($wiki, $subwiki, $cm)
	page_wiki constructor More...
	print_content ()
	This method must be overwritten to print the page content. More...
	print_footer ()
	This method print the footer of the page. More...
	print_header ()
	This method prints the top of the page. More...
	set_gid ($gid)
	Method to set current group id. More...
	set_page ($page)
	Method to set the current page. More...
	set_title ($title)
	Method to set the current page title. More...
	set_uid ($uid)
	Method to set current user id. More...

Protected Member Functions
	create_navbar ()
	Protected method to create the common items of the navbar in every page type. More...
	print_pagetitle ()
	Protected method to print current page title. More...
	process_session_url ()
	set_session_url ()
	set_url ()
	Method to set the URL of the page. More...
	setup_tabs ($options=array())
	Setup page tabs, if options is empty, will set up active tab automatically. More...

Protected Attributes
stdClass	$cm
	course module.
int	$gid
	Current group ID.
object	$modcontext
	module context object
int	$page
	Current page.
object	$subwiki
	Current subwiki.
array	$tabs
	The tabs set used in wiki module. More...
array	$tabs_options = array()
	tabs options
string	$title
	Current page title.
int	$uid
	Current user ID.
mod_wiki_renderer	$wikioutput
	wiki renderer

Detailed Description

Class page_wiki contains the common code between all pages.

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

page_wiki::__construct	(		$wiki,
			$subwiki,
			$cm
	)

page_wiki constructor

Parameters

$wiki.	Current wiki
$subwiki.	Current subwiki.
$cm.	Current course_module.

Reimplemented in page_wiki_edit, page_wiki_history, page_wiki_prettyview, and page_wiki_admin.

Member Function Documentation

create_navbar()

page_wiki::create_navbar ( )

protected

Protected method to create the common items of the navbar in every page type.

Reimplemented in page_wiki_view, page_wiki_edit, page_wiki_comments, page_wiki_editcomment, page_wiki_search, page_wiki_create, page_wiki_diff, page_wiki_history, page_wiki_map, page_wiki_restoreversion, page_wiki_deletecomment, page_wiki_viewversion, and page_wiki_admin.

print_content()

page_wiki::print_content

(

)

This method must be overwritten to print the page content.

Reimplemented in page_wiki_view, page_wiki_edit, page_wiki_comments, page_wiki_editcomment, page_wiki_search, page_wiki_preview, page_wiki_diff, page_wiki_history, page_wiki_map, page_wiki_restoreversion, page_wiki_deletecomment, page_wiki_save, page_wiki_viewversion, page_wiki_confirmrestore, page_wiki_prettyview, page_wiki_handlecomments, page_wiki_lock, page_wiki_overridelocks, and page_wiki_admin.

print_footer()

page_wiki::print_footer

(

)

This method print the footer of the page.

Reimplemented in page_wiki_lock.

print_header()

page_wiki::print_header

(

)

This method prints the top of the page.

Reimplemented in page_wiki_view, page_wiki_edit, page_wiki_comments, page_wiki_editcomment, page_wiki_search, page_wiki_create, page_wiki_preview, page_wiki_diff, page_wiki_history, page_wiki_map, page_wiki_restoreversion, page_wiki_deletecomment, page_wiki_save, page_wiki_viewversion, page_wiki_confirmrestore, page_wiki_prettyview, page_wiki_handlecomments, page_wiki_lock, page_wiki_overridelocks, and page_wiki_admin.

print_pagetitle()

page_wiki::print_pagetitle ( )

protected

Protected method to print current page title.

Reimplemented in page_wiki_edit, and page_wiki_history.

set_gid()

page_wiki::set_gid

(

$gid

)

Method to set current group id.

Parameters

int

$gid

Current group id

set_page()

page_wiki::set_page

(

$page

)

Method to set the current page.

Parameters

object

$page

Current page

set_title()

page_wiki::set_title

(

$title

)

Method to set the current page title.

This method must be called when the current page is not created yet.

Parameters

string

$title

Current page title.

set_uid()

page_wiki::set_uid

(

$uid

)

Method to set current user id.

Parameters

int

$uid

Current user id

set_url()

page_wiki::set_url ( )

protected

Method to set the URL of the page.

This method must be overwritten by every type of page.

Reimplemented in page_wiki_view, page_wiki_edit, page_wiki_comments, page_wiki_editcomment, page_wiki_search, page_wiki_create, page_wiki_preview, page_wiki_diff, page_wiki_history, page_wiki_map, page_wiki_restoreversion, page_wiki_deletecomment, page_wiki_viewversion, page_wiki_confirmrestore, page_wiki_prettyview, page_wiki_handlecomments, page_wiki_lock, page_wiki_overridelocks, and page_wiki_admin.

setup_tabs()

page_wiki::setup_tabs (   $options = array() )

protected

Setup page tabs, if options is empty, will set up active tab automatically.

Parameters

array

$options,tabs

options

Reimplemented in page_wiki_editcomment, page_wiki_preview, page_wiki_diff, page_wiki_restoreversion, page_wiki_deletecomment, and page_wiki_viewversion.

Member Data Documentation

$tabs

array page_wiki::$tabs

protected

Initial value:

= array('view' => 'view', 'edit' => 'edit', 'comments' => 'comments',
                            'history' => 'history', 'map' => 'map', 'files' => 'files',
                            'admin' => 'admin')

The tabs set used in wiki module.

---

The documentation for this class was generated from the following file:

• mod/wiki/pagelib.php