prepend.inc.php File Reference

This page setup the world (global variable), import plugins and finally handle user action. More...

Functions
	dumpVariables ($string)
Variables
	$php_start_time = chrono::now()
	global php start time
	$browser_title_page = 'Wiclear'
	a title describing the page and the eventual action going on
	$wikiRendererConfig = new WiclearWikiRendererConfig()
	global wiki renderer configuration variable
	$con = new mysql(wc_db_host, wc_db_login, wc_db_password, wc_db_database)
	global connection to database variable
	$con = new null_db()
	$theme_path = 'themes/'
	theme path
	$theme = wc_theme
	the theme we want to load
	$con = new null_db()
	$error_message
	$template_path = 'themes/default/template.php'
	$template_prepend_file = 'themes/default/prepend.inc.php'
	$user = auth::checkRights($wiki)
	current connected user
	$ui_lang = wc_default_lang
	lang of user for the interface, always set to prefered lang of user
	$user_lang = wc_default_lang
	$mainPage = true
	if we're looking to the main page of the site or not
$node	parents = array()
	$wiki = new wiki($con, '')
	$user = $wiki->anonymousUser()
	$user_lang = wc_default_lang
	$ui_lang = wc_default_lang
	$mainPage = true
	$showTOC = ($mode != 'print' && wc_show_toc == 'true')
	global variable. indicates if we want to show table of content on current page
	$editBySection = ($mode != 'print' && wc_edit_by_section == 'true')
	global variable. indicates if we want to edit a page by section
	$mainPageHandler = ''
	global variable. This is a callback to load main page (no title, no mode, no nada)
	$javascriptLibs = array()
	global variable to control external javascript library to include
	$contentBoxHandle = array()
	global variable to control main area display
	$userActionHandle = array()
	global variable to control user interaction
	$browserTitlePageHandle = array()
	global variable to customize title in browser if no mode is active, default handle "default" is used, else handle $mode is used.
	$pluginManager = new PluginManager(wc_inc_path)
	global variable the plugin manager

---

Detailed Description

This page setup the world (global variable), import plugins and finally handle user action.

The world consists of several objects :

• The configuration : ini
• The connection to the database : con
• The controller : wiki
• The wiki renderer : wikiRenderer
• The current user : user

other global variables are created :

• the title : title
• the mode : mode
• the user lang for the ui : ui_lang
• the user lang for the content : user_lang
• the theme : theme

Finally, when the world is setup, the available plugins are imported and a special function : handleUserAction() is called. This function is responsible for reacting on user input before any other content is displayed.

---

Variable Documentation

$browser_title_page = 'Wiclear'

a title describing the page and the eventual action going on

$browserTitlePageHandle = array()

global variable to customize title in browser if no mode is active, default handle "default" is used, else handle $mode is used.

$con = new mysql(wc_db_host, wc_db_login, wc_db_password, wc_db_database)

global connection to database variable

$contentBoxHandle = array()

global variable to control main area display

This is a map<mode=>callback> If no mode is active, then current wiki page will be displayed. If a mode is active, and this mode exists in the map, the corresponding callback is called. For example, the login page add a callback to the function loginBox() from the mode "login". The mode is read from the url either via the "mode" HTML GET variable, or by the SpecialPage syntax. The callback signature is :

void callback()

Plugins can use this global array to dynamically add new functionalities

$editBySection = ($mode != 'print' && wc_edit_by_section == 'true')

global variable. indicates if we want to edit a page by section

$error_message

Initial value:

  tr('No configuration. Perhaps have you just deployed Wiclear.').'%%%'.
  tr('In that case, you now need to go to the').' [install program|'.$app_path.'install/], '.
  tr('to setup configuration and finish installation')

$javascriptLibs = array()

global variable to control external javascript library to include

Each page that want to include a javascript library should add a relative link from the "tool" path. This is used only in site_plan plugin for now.

$mainPage = true

if we're looking to the main page of the site or not

$mainPageHandler = ''

global variable. This is a callback to load main page (no title, no mode, no nada)

$php_start_time = chrono::now()

global php start time

$pluginManager = new PluginManager(wc_inc_path)

global variable the plugin manager

$showTOC = ($mode != 'print' && wc_show_toc == 'true')

global variable. indicates if we want to show table of content on current page

$theme = wc_theme

the theme we want to load

$theme_path = 'themes/'

theme path

$ui_lang = wc_default_lang

lang of user for the interface, always set to prefered lang of user

$user = auth::checkRights($wiki)

current connected user

$userActionHandle = array()

global variable to control user interaction

This is a map<mode=>callback> If no mode is active, nothing will be called. If a mode is active, and this mode exists in the map, the corresponding callback is called. This callback is called before anything. So you can use header() call to make redirection. For example, the login page add a callback to the function onLogin() from the mode "login". The mode is read from the url either via the "mode" HTML GET variable, or by the SpecialPage syntax. The callback signature is :

void callback()

Plugins can use this global array to dynamically add new functionalities

$wikiRendererConfig = new WiclearWikiRendererConfig()

global wiki renderer configuration variable

---