page_wiki_admin Class Reference

This class will let user to delete wiki pages and page versions. More...

Inheritance diagram for page_wiki_admin:

Public Member Functions
object	__construct ($wiki, $subwiki, $cm)
	Constructor. More...
	print_content ()
	This function will display administration view to users with managewiki capability. More...
	print_footer ()
	This method print the footer of the page. More...
	print_header ()
	Prints header for wiki 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...
object	set_url ()
	Sets page url. More...
	set_view ($view, $listorphan=true)
	Sets admin view option. More...

Public Attributes
	$action
	$listorphan = false
	$view

Protected Member Functions
object	add_page_delete_options ($pages, $swid, &$table)
	helper function for print_delete_content. More...
object	create_navbar ()
	sets navigation bar for the page More...
	print_delete_content ($showorphan=true)
	Show wiki page delete options. More...
	print_pagetitle ()
	Protected method to print current page title. More...
	process_session_url ()
	set_session_url ()
	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

This class will let user to delete wiki pages and page versions.

Constructor & Destructor Documentation

__construct()

object page_wiki_admin::__construct	(		$wiki,
			$subwiki,
			$cm
	)

Constructor.

$PAGE

Parameters

mixed	$wiki	instance of wiki
mixed	$subwiki	instance of subwiki
stdClass	$cm	course module

Reimplemented from page_wiki.

Member Function Documentation

add_page_delete_options()

object page_wiki_admin::add_page_delete_options (   $pages,   $swid, &  $table  )

protected

helper function for print_delete_content.

This will add data to the table.

$OUTPUT

Parameters

array	$pages	objects of wiki pages in subwiki
int	$swid	id of subwiki
object	$table	reference to the table in which data needs to be added

create_navbar()

object page_wiki_admin::create_navbar ( )

protected

sets navigation bar for the page

$PAGE

Reimplemented from page_wiki.

print_content()

page_wiki_admin::print_content

(

)

This function will display administration view to users with managewiki capability.

Reimplemented from page_wiki.

print_delete_content()

page_wiki_admin::print_delete_content (   $showorphan = true )

protected

Show wiki page delete options.

Parameters

bool

$showorphan

print_footer()

page_wiki::print_footer ( )

inherited

This method print the footer of the page.

Reimplemented in page_wiki_lock.

print_header()

page_wiki_admin::print_header

(

)

Prints header for wiki page.

Reimplemented from page_wiki.

print_pagetitle()

page_wiki::print_pagetitle ( )

protectedinherited

Protected method to print current page title.

Reimplemented in page_wiki_edit, and page_wiki_history.

set_gid()

page_wiki::set_gid (   $gid )

inherited

Method to set current group id.

Parameters

int

$gid

Current group id

set_page()

page_wiki::set_page (   $page )

inherited

Method to set the current page.

Parameters

object

$page

Current page

set_title()

page_wiki::set_title (   $title )

inherited

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 )

inherited

Method to set current user id.

Parameters

int

$uid

Current user id

set_url()

object page_wiki_admin::set_url

(

)

Sets page url.

$PAGE @global object $CFG

Reimplemented from page_wiki.

set_view()

page_wiki_admin::set_view	(		$view,
			$listorphan = true
	)

Sets admin view option.

Parameters

int	$view	page view id
bool	$listorphan	is only valid for view 1.

setup_tabs()

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

protectedinherited

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

protectedinherited

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