page_wiki_edit Class Reference

Wiki page editing page. More...

Inheritance diagram for page_wiki_edit:

Public Member Functions
	__construct ($wiki, $subwiki, $cm, ?string $activesecondarytab=null)
	The page_wiki_edit constructor.
	print_content ()
	This method must be overwritten to print the page content.
	print_footer ()
	This method print the footer of the page.
	print_header ()
	This method prints the top of the page.
	set_attachments ($attachments)
	set_deleteuploads ($deleteuploads)
	set_format ($format)
	set_gid ($gid)
	Method to set current group id.
	set_overridelock ($override)
	set_page ($page)
	Method to set the current page.
	set_section ($sectioncontent, $section)
	set_title ($title)
	Method to set the current page title.
	set_uid ($uid)
	Method to set current user id.
	set_upload ($upload)
	set_versionnumber ($versionnumber)

Static Public Attributes
static	$attachmentoptions

Protected Member Functions
	action_bar (int $pageid, moodle_url $pageurl)
	This method returns the action bar.
	check_locks ()
	create_navbar ()
	Protected method to create the common items of the navbar in every page type.
	print_edit ($content=null)
	print_pagetitle ()
	Protected method to print current page title.
	process_session_url ()
	set_session_url ()
	set_url ()
	Method to set the URL of the page.
	setup_tabs ($options=array())
	Setup page tabs, if options is empty, will set up active tab automatically.

Protected Attributes
	$attachments = 0
stdClass	$cm
	course module.
	$deleteuploads = array()
	$format
int	$gid
	Current group ID.
object	$modcontext
	module context object
	$overridelock = false
int	$page
	Current page.
string	$section
	the section name needed to be edited
	$sectioncontent
object	$subwiki
	Current subwiki.
array	$tabs
	The tabs set used in wiki module.
array	$tabs_options = array()
	tabs options
string	$title
	Current page title.
int	$uid
	Current user ID.
	$upload = false
	$versionnumber = -1
mod_wiki_renderer	$wikioutput
	wiki renderer

Detailed Description

Wiki page editing page.

License

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

Constructor & Destructor Documentation

__construct()

page_wiki_edit::__construct	(		$wiki,
			$subwiki,
			$cm,
		?string	$activesecondarytab = null )

The page_wiki_edit constructor.

Parameters

stdClass	$wiki	Current wiki
stdClass	$subwiki	Current subwiki.
stdClass	$cm	Current course_module.
string | null	$activesecondarytab	Secondary navigation node to be activated on the page, if required

Reimplemented from page_wiki.

Member Function Documentation

action_bar()

page_wiki::action_bar ( int $pageid, moodle_url $pageurl )

protectedinherited

This method returns the action bar.

Parameters

int	$pageid	The page id.
moodle_url	$pageurl	The page url.

Return values

string

The HTML for the action bar.

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

create_navbar()

page_wiki_edit::create_navbar ( )

protected

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

Reimplemented from page_wiki.

print_content()

page_wiki_edit::print_content

(

)

This method must be overwritten to print the page content.

Reimplemented from page_wiki.

Reimplemented in page_wiki_confirmrestore, page_wiki_lock, page_wiki_overridelocks, page_wiki_preview, and page_wiki_save.

print_footer()

page_wiki::print_footer ( )

inherited

This method print the footer of the page.

Reimplemented in page_wiki_lock.

print_header()

page_wiki_edit::print_header

(

)

This method prints the top of the page.

Reimplemented from page_wiki.

Reimplemented in page_wiki_confirmrestore, page_wiki_lock, page_wiki_overridelocks, page_wiki_preview, and page_wiki_save.

print_pagetitle()

page_wiki_edit::print_pagetitle ( )

protected

Protected method to print current page title.

Reimplemented from page_wiki.

process_session_url()

page_wiki_edit::process_session_url ( )

protected

Reimplemented from page_wiki.

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_session_url()

page_wiki_edit::set_session_url ( )

protected

Reimplemented from page_wiki.

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()

page_wiki_edit::set_url ( )

protected

Method to set the URL of the page.

This method must be overwritten by every type of page.

Reimplemented from page_wiki.

Reimplemented in page_wiki_confirmrestore, page_wiki_lock, page_wiki_overridelocks, and page_wiki_preview.

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_deletecomment, page_wiki_diff, page_wiki_editcomment, page_wiki_preview, page_wiki_restoreversion, 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