Moodle  2.2.1
http://www.collinsharper.com
page_wiki Class Reference
Inheritance diagram for page_wiki:

Public Member Functions

 __construct ($wiki, $subwiki, $cm)
 print_header ()
 print_content ()
 set_page ($page)
 set_title ($title)
 set_gid ($gid)
 set_uid ($uid)
 print_footer ()

Protected Member Functions

 print_pagetitle ()
 setup_tabs ($options=array())
 set_url ()
 create_navbar ()
 process_session_url ()
 set_session_url ()

Protected Attributes

 $subwiki
 $page
 $title
 $gid
 $modcontext
 $uid
 $tabs
 $tabs_options = array()
 $wikioutput

Detailed Description

Class page_wiki contains the common code between all pages

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

Definition at line 44 of file pagelib.php.


Constructor & Destructor Documentation

__construct ( wiki,
subwiki,
cm 
)

page_wiki constructor

Parameters:
$wiki.Current wiki
$subwiki.Current subwiki.
$cm.Current course_module.

Reimplemented in page_wiki_admin, page_wiki_history, page_wiki_preview, and page_wiki_edit.

Definition at line 97 of file pagelib.php.

Here is the call graph for this function:


Member Function Documentation

create_navbar ( ) [protected]

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

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

Definition at line 250 of file pagelib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

This method print the footer of the page.

Reimplemented in page_wiki_lock.

Definition at line 259 of file pagelib.php.

print_pagetitle ( ) [protected]

Protected method to print current page title.

Reimplemented in page_wiki_history, and page_wiki_edit.

Definition at line 142 of file pagelib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

process_session_url ( ) [protected]

Reimplemented in page_wiki_edit.

Definition at line 264 of file pagelib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

set_gid ( gid)

Method to set current group id

Parameters:
int$gidCurrent group id

Definition at line 227 of file pagelib.php.

set_page ( page)

Method to set the current page

Parameters:
object$pageCurrent page

Definition at line 202 of file pagelib.php.

set_session_url ( ) [protected]

Reimplemented in page_wiki_overridelocks, page_wiki_lock, page_wiki_save, and page_wiki_edit.

Definition at line 276 of file pagelib.php.

Here is the caller graph for this function:

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

Definition at line 215 of file pagelib.php.

set_uid ( uid)

Method to set current user id

Parameters:
int$uidCurrent user id

Definition at line 235 of file pagelib.php.

setup_tabs ( options = array()) [protected]

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

Parameters:
array$options,tabsoptions

Definition at line 156 of file pagelib.php.

Here is the call graph for this function:

Here is the caller graph for this function:


Field Documentation

$gid [protected]

Definition at line 64 of file pagelib.php.

$modcontext [protected]

Definition at line 69 of file pagelib.php.

$page [protected]

Definition at line 54 of file pagelib.php.

$subwiki [protected]

Definition at line 49 of file pagelib.php.

$tabs [protected]
Initial value:
 array('view' => 'view', 'edit' => 'edit', 'comments' => 'comments',
                            'history' => 'history', 'map' => 'map', 'files' => 'files',
                            'admin' => 'admin')

Definition at line 78 of file pagelib.php.

$tabs_options = array() [protected]

Definition at line 84 of file pagelib.php.

$title [protected]

Definition at line 59 of file pagelib.php.

$uid [protected]

Definition at line 74 of file pagelib.php.

$wikioutput [protected]

Definition at line 88 of file pagelib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations