wiki.inc.php File Reference

Data Structures
class	line_diff
class	DiffLine

Functions
	getWikiPage ($keyword, $version=null)
	submitWikiPage ($keyword, $version, $body, $user_id, $range_id, $ancestor)
	getLatestVersion ($keyword, $range_id)
	getFirstVersion ($keyword, $range_id)
	getWikiPageVersions ($keyword, $limit=10, $getfirst=false)
	keywordExists ($str, $sem_id=null)
	isKeyword ($str, $page, $format= 'wiki', $sem_id=null, $alt_str=null)
	getLock ($keyword, $user_id)
	setWikiLock ($db, $user_id, $range_id, $keyword)
	releaseLocks ($keyword)
	releasePageLocks ($keyword, $user_id)
	getWikiLinks ($str)
	getBacklinks ($keyword)
	refreshBacklinks ($keyword, $str)
	deleteAncestorRelation ($keyword)
	getZusatz ($wikiData)
	getWikiIndex ($descendants, $i=0)
	showDeleteDialog ($keyword, $version)
	showDeleteAllDialog ($keyword)
	deleteWikiPage ($keyword, $version, $range_id)
	deleteAllWikiPage ($keyword, $range_id)
	listPages ($mode, $sortby=NULL)
	listPageVersions ($keyword, $sortby=null)
	searchWiki ($searchfor, $searchcurrentversions, $keyword, $localsearch)
	wikiEdit ($keyword, $wikiData, $user_id, $backpage=NULL, $ancestor=NULL)
	printWikiPage ($keyword, $version)
	exportWikiPagePDF ($keyword, $version)
	exportAllWikiPagesPDF ($mode, $sortby)
	deleteWikiLinks ($keyword)
	exportWiki ()
	printAllWikiPages ($range_id, $header)
	getAllWikiPages ($range_id, $header, $fullhtml=true)
	showPageFrameStart ()
	showPageFrameEnd ()
	getShowPageInfobox ($keyword, $latest_version)
	getDiffPageInfobox ($keyword)
	get_toc_toggler ()
	get_toc_content ()
	showWikiPage ($keyword, $version, $special="", $show_comments="icon", $hilight=NULL)
	showDiffs ($keyword, $versions_since)
	do_diff ($strlines1, $strlines2)
	toDiffLineArray ($lines, $who)
	showComboDiff ($keyword, $db=NULL)

Function Documentation

deleteAllWikiPage	(		$keyword,
			$range_id
	)

Delete complete WikiPage with all versions and adjust backlinks.

Parameters

string	WikiPage name
string	ID of seminar/einrichtung

deleteAncestorRelation

(

$keyword

)

When a page gets deleted, set the ancestor to NULL for every descendant page.

Parameters

string

keyword WikiPage name that was deleted.

deleteWikiLinks

(

$keyword

)

deleteWikiPage	(		$keyword,
			$version,
			$range_id
	)

Delete WikiPage version and adjust backlinks.

Parameters

string	WikiPage name
string	WikiPage version
string	ID of seminar/einrichtung

Returns

string WikiPage name to display next

do_diff	(		$strlines1,
			$strlines2
	)

exportAllWikiPagesPDF	(		$mode,
			$sortby
	)

exportWiki

(

)

Show export all dialog

exportWikiPagePDF	(		$keyword,
			$version
	)

get_toc_content

(

)

get_toc_toggler

(

)

getAllWikiPages	(		$range_id,
			$header,
			$fullhtml = true
	)

Return HTML-dump of all wiki pages. Implements an iterative breadth-first traversal of WikiPage-tree.

Parameters

string	$range_id	ID of veranstaltung/einrichtung
string	$header	Short title (header) of veranstaltung/einrichtung
bool	$fullhtml	Include html/head/body tags?

Returns

string

getBacklinks

(

$keyword

)

Return list of WikiPages containing links to given page

Parameters

string

Wiki keyword

getDiffPageInfobox

(

$keyword

)

Returns an infobox string holding information and action links for diff view of current page.

Parameters

string

WikiPage name

getFirstVersion	(		$keyword,
			$range_id
	)

Retrieve oldest version for a given keyword

Parameters

string

WikiPage name

Returns

array

getLatestVersion	(		$keyword,
			$range_id
	)

Retrieve latest version for a given keyword

Parameters

string

keyword WikiPage name

Returns

array

getLock	(		$keyword,
			$user_id
	)

Get lock information about page Returns displayable string containing lock information (Template: Username1 (seit x Minuten), Username2 (seit y Minuten), ...) or NULL if no locks set.

Parameters

string	WikiPage keyword
string	user_id Internal user id

getShowPageInfobox	(		$keyword,
			$latest_version
	)

Returns an infobox string holding information and action links for current page. If newest version is displayed, infobox includes backlinks.

Parameters

string	WikiPage name
bool	Is version displayed latest version?

getWikiIndex	(		$descendants,
			$i = 0
	)

getWikiLinks

(

$str

)

Return list of WikiWord in given page body ($str)

Parameters

string

str

getWikiPage	(		$keyword,
			$version = null
	)

Retrieve a WikiPage version from current seminar's WikiWikiWeb.

Returns raw text data from database if requested version is available. If not, an

Parameters

string	WikiWiki keyword to be retrieved
int	Version number. If empty, latest version is returned.

getWikiPageVersions	(		$keyword,
			$limit = 10,
			$getfirst = false
	)

Return array containing version numbes and chdates

Parameters

string	$keyword	Wiki keyword for currently selected seminar
int	$limit	Number of links to be retrieved (default:10)
bool	$getfirst	Should first (=most recent) version be retrieved too?

Returns

array

getZusatz

(

$wikiData

)

Generate Meta-Information on Wiki-Page to display in top line

Parameters

db-query

result all information about a wikiPage

Returns

string Displayable HTML

isKeyword	(		$str,
			$page,
			$format = 'wiki',
			$sem_id = null,
			$alt_str = null
	)

Check if keyword already exists or links to new page. Returns HTML-Link-Representation.

Parameters

string	WikiPage keyword
string	current Page (for edit abort backlink)
string	out format: "wiki"=link to wiki.php, "inline"=link on same page

keywordExists	(		$str,
			$sem_id = null
	)

Check if given keyword exists in current WikiWikiWeb.

Parameters

string

WikiPage keyword

listPages	(		$mode,
			$sortby = NULL
	)

List all topics in this seminar's wiki

Parameters

mode	string Either "all" or "new", affects default sorting and page title.
sortby	string Different sortings of entries.

listPageVersions	(		$keyword,
			$sortby = null
	)

List all versions of a wiki page

Parameters

string	$keyword	WikiPage name
string | null	$sortby	Different sortings of entries.

printAllWikiPages	(		$range_id,
			$header
	)

Print HTML-dump of all wiki pages.

Parameters

string	ID of veranstaltung/einrichtung
string	Short title (header) of veranstaltung/einrichtung

printWikiPage	(		$keyword,
			$version
	)

Display wiki page for print.

Parameters

string	keyword WikiPage name
string	version WikiPage version

refreshBacklinks	(		$keyword,
			$str
	)

Refresh wiki_links table for backlinks from given page to other pages

Parameters

string	keyword WikiPage-name for $str content
string	str Page content containing links

releaseLocks

(

$keyword

)

Release all locks for wiki page that are older than 30 minutes.

Parameters

string

WikiPage keyword

releasePageLocks	(		$keyword,
			$user_id
	)

Release locks for current wiki page and current user

Parameters

string	keyword WikiPage name
string	user_id Internal user id

searchWiki	(		$searchfor,
			$searchcurrentversions,
			$keyword,
			$localsearch
	)

Search Wiki

Parameters

searchfor	string String to search for.
searchcurrentversions	bool it true, only consider most recent versions or pages
keyword	string last shown page or keyword for local (one page) search
keyword	bool if localsearch is set, only one page (all versions) is searched

setWikiLock	(		$db,
			$user_id,
			$range_id,
			$keyword
	)

Set lock for current user and current page

Parameters

DB_Seminar	db DB_Seminar instance (no longer neccessary)
string	user_id Internal user id
string	range_if Internal seminar id
string	keyword WikiPage name

showComboDiff	(		$keyword,
			$db = NULL
	)

showDeleteAllDialog

(

$keyword

)

showDeleteDialog	(		$keyword,
			$version
	)

Display yes/no dialog to confirm WikiPage version deletion.

Parameters

string	WikiPage name
string	WikiPage version (if empty: take latest)

Returns

string Version number to delete

showDiffs	(		$keyword,
			$versions_since
	)

Display Page diffs, restrictable to recent versions

Parameters

string	WikiPage name
string	Only show versions newer than this timestamp

showPageFrameEnd

(

)

Display the right and bottom part of a page "frame".

Renders an infobox and closes the table.

Parameters

array

ready to pass to print_infoxbox()

showPageFrameStart

(

)

Display start of page "frame", i.e. open correct table structure.

showWikiPage	(		$keyword,
			$version,
			$special = "",
			$show_comments = "icon",
			$hilight = NULL
	)

Display wiki page.

Parameters

string	WikiPage name
string	WikiPage version
string	ID of special dialog to be printed (delete)
string	Comment show mode (all, none, icon)

submitWikiPage	(		$keyword,
			$version,
			$body,
			$user_id,
			$range_id,
			$ancestor
	)

Write a new/edited wiki page to database

Parameters

string	keyword WikiPage name
string	version WikiPage version
string	body WikiPage text
string	user_id Internal user id of editor
string	range_id Internal id of seminar/einrichtung

toDiffLineArray	(		$lines,
			$who
	)

wikiEdit	(		$keyword,
			$wikiData,
			$user_id,
			$backpage = NULL,
			$ancestor = NULL
	)

Display edit form for wiki page.

Parameters

string	keyword WikiPage name
array	wikiData Array from DB with WikiPage data
string	user_id Internal user id
string	backpage Page to display if editing is aborted