boxes.lib.php File Reference

this page includes all other native features and provide minimal functionalities More...

Functions
	jsLinks ()
	generates javascript links so that a user can easily incorporates javascript defined in plugins
	getRootNodeLink ()
	builds a link to wiki root page generates an anchor link pointing to wiki root page, for use in template :
	accessMenu ()
	builds an access menu to different wiki parts
	wikiMenu ()
	builds a complete wiki menu generates an unordered list of links depending of state (user logged, global rights ...) that contain : edit link add content link edit ACL link delete node link history link subscribe/unsubscribe link
	contentBox ()
	display main content area the main content area contains either the wiki content, or content based on mode (edition, search ...) It uses the global map variable $contentBoxHandle and the mode to callback a registered method that can handle the page. If no mode is found, or if no function is registered to handle current mode, the special method registered to the "default" mode is called.
	handleUserAction ()
	handle user action
	handleBrowserTitlePage ()
	handle browser title page customisation
	loadCurrentPage ()
	load page info from database

---

Detailed Description

this page includes all other native features and provide minimal functionalities

Important functions are :

• wikiMenu() for the generation of a basic wiki menu
• contentBox() for the displaying of main area
• handleUserAction() for handling user interaction
• jsLinks() for generating links to javascript libraries when needed

3 global variables are used for that :

• $javascriptLibs : this array contain the list of required javascript lib to include
• $contentBoxHandle : this map<mode=>callback> allows easy redirection to a particular page from a given mode
• $userActionHandle : this map<mode=>callback> allows easy user interaction from a given mode

---

Function Documentation

accessMenu

(

)

builds an access menu to different wiki parts

handleBrowserTitlePage

(

)

handle browser title page customisation

called after world setup and event handling

handleUserAction

(

)

handle user action

called after the world is set up and before the them template builds up the page

loadCurrentPage

(

)

load page info from database

called after world setup and before event handling if this is the main page, then gives a page to $mainPageHandler to intercept the call (usefull to avoid loading the root node if you want to display something else) else, it loads the page from GET variable title and current $user_lang

---