Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
page_wiki_editcomment Class Reference

Class that models the behavior of wiki's edit comment. More...

Inheritance diagram for page_wiki_editcomment:
page_wiki

Public Member Functions

 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_action ($action, $comment)
 
 set_gid ($gid)
 Method to set current group id.
 
 set_page ($page)
 Method to set the current page.
 
 set_title ($title)
 Method to set the current page title.
 
 set_uid ($uid)
 Method to set current user id.
 
 set_url ()
 Method to set the URL of the page.
 

Protected Member Functions

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

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.
 
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 that models the behavior of wiki's edit comment.

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

Member Function Documentation

◆ action_bar()

page_wiki_editcomment::action_bar ( int $pageid,
moodle_url $pageurl )
protected

This method returns the action bar.

Parameters
int$pageidThe page id.
moodle_url$pageurlThe page url.
Return values
stringThe HTML for the action bar.

Reimplemented from page_wiki.

◆ create_navbar()

page_wiki_editcomment::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_editcomment::print_content ( )

This method must be overwritten to print the page content.

Reimplemented from page_wiki.

◆ print_footer()

page_wiki::print_footer ( )
inherited

This method print the footer of the page.

Reimplemented in page_wiki_lock.

◆ print_header()

page_wiki_editcomment::print_header ( )

This method prints the top of the 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$gidCurrent group id

◆ set_page()

page_wiki::set_page ( $page)
inherited

Method to set the current page.

Parameters
object$pageCurrent 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$titleCurrent page title.

◆ set_uid()

page_wiki::set_uid ( $uid)
inherited

Method to set current user id.

Parameters
int$uidCurrent user id

◆ set_url()

page_wiki_editcomment::set_url ( )

Method to set the URL of the page.

This method must be overwritten by every type of page.

Reimplemented from page_wiki.

◆ setup_tabs()

page_wiki_editcomment::setup_tabs ( $options = array())
protected

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

Parameters
array$options,tabsoptions

Reimplemented from page_wiki.

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: