history.lib.php File Reference

Controls history viewing/diffing. More...

Functions
	browserHistory ()
	customize browser title when viewing history
	browserHistoryView ()
	customize browser title when viewing a version of the content
	browserHistoryViewByDate ()
	customize browser title when viewing history at a date
	browserHistoryDiff ()
	customize browser title when diffing versions
	historyLink ()
	creates a link to history
	history ()
	display history versions
	historyView ()
	display a particular history version by id
	historyViewByDate ()
	display a particular history version by date
	createTitle ($node)
	create title to display differences
	historyDiff ()
	perform diff and display it
	historyDelete ()
	Confirm delete history.
	onHistoryDelete ()
	delete history from history form
	historyDeleteAll ()
	Confirm delete all history.
	onHistoryDeleteAll ()
	delete all history from history form
Variables
	$contentBoxHandle ['history'] = 'history'
	$contentBoxHandle ['history_view'] = 'historyView'
	$contentBoxHandle ['history_view_by_date'] = 'historyViewByDate'
	$contentBoxHandle ['history_diff'] = 'historyDiff'
	$contentBoxHandle ['history_del'] = 'historyDelete'
	$contentBoxHandle ['history_del_all'] = 'historyDeleteAll'
	$userActionHandle ['history_del_confirm'] = 'onHistoryDelete'
	$userActionHandle ['history_del_all_confirm'] = 'onHistoryDeleteAll'
	$browserTitlePageHandle ['history'] = 'browserHistory'
	$browserTitlePageHandle ['history_view'] = 'browserHistoryView'
	$browserTitlePageHandle ['history_view_by_date'] = 'browserHistoryViewByDate'
	$browserTitlePageHandle ['history_diff'] = 'browserHistoryDiff'

---

Detailed Description

Controls history viewing/diffing.

This file creates several hooks :

• history : to display list of available history
• history_view : to view a particular version by history id
• history_view_by_date : to view a particular version by date (the precision is the day)
• history_diff : to diff a version against another
• history_del : to delete a particular version. If the current version is deleted, then the latest version is restored as current content

History viewing is done via a table. Each line is a particular version. At the end of each line there is a radio button that allows the user to select 2 different versions.

• If the user clicks on the version, or on the title, then the version is shown by history id.
• If the user clicks on the date, then the version is shown by date (and the url used is a permalink).
• If the user clicks on the "Show diff" button, then the two versions selected are diffed, which allows the user to see differences that happened between the versions

This page contains also several helper functions for the user to create template :

• historyLink

---

Function Documentation

browserHistory

(

)

customize browser title when viewing history

Returns:

browser title

browserHistoryDiff

(

)

customize browser title when diffing versions

Returns:

browser title

browserHistoryView

(

)

customize browser title when viewing a version of the content

Returns:

browser title

browserHistoryViewByDate

(

)

customize browser title when viewing history at a date

Returns:

browser title

createTitle

(

$

node

)

create title to display differences

Parameters:

node

the node to create title for

Returns:

title

history

(

)

display history versions

Returns:

html blob

historyDelete

(

)

Confirm delete history.

Returns:

html blob

historyDeleteAll

(

)

Confirm delete all history.

Returns:

html blob

historyDiff

(

)

perform diff and display it

Returns:

html blob

historyView

(

)

display a particular history version by id

Returns:

html blob

historyViewByDate

(

)

display a particular history version by date

the precision is the date. The displayed version is the last version of the day. It is possible to go beyond subsecond precision, but it will need to add more arguments to url (at least hour, min, sec)

Returns:

html blob

onHistoryDelete

(

)

delete history from history form

onHistoryDeleteAll

(

)

delete all history from history form

---