watch.lib.php File Reference

Controls the main functionality : content edition. More...

Functions
	browserWatchView ()
	customize browser title when viewing watches
	emailSubscribeLink ()
	display link to subscribe to this node
	emailUnsubscribeLink ()
	display link to unsubscribe to this node
	watchViewBox ()
	display list of nodes this user has subscribed to
	onWatch ()
	called when user click on subscribe link
	onUnwatch ()
	called when user click on unsubscribe link
	onUnwatchById ()
	called when user click on unsubscribe link in watchViewBox
	onWatchRecursively ()
	called when user click on subscribe link in watchViewBox
	onUnwatchAll ()
	called when user click on unsubscribe all link in watchViewBox
Variables
	$contentBoxHandle ['watch_view'] = 'watchViewBox'
	$userActionHandle ['watch'] = 'onWatch'
	$userActionHandle ['unwatch'] = 'onUnwatch'
	$userActionHandle ['unwatch_by_id'] = 'onUnwatchById'
	$userActionHandle ['watch_rec'] = 'onWatchRecursively'
	$userActionHandle ['unwatch_all'] = 'onUnwatchAll'
	$browserTitlePageHandle ['watch_view'] = 'browserWatchView'

---

Detailed Description

Controls the main functionality : content edition.

This file creates several hooks :

• watch_view : to see the list of subscription of a user
• watch : to register to a particular page
• unwatch_by_id : to unregister from a particular page
• watch_rec : to register to a page and to all its sub pages

The display page can be called from user preferences. The page contain only a list of links. Links to stop watching a page, links to subscribe to all sub nodes of a page, and a link to unsubscribe to all.

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

• emailSubscribeLink
• emailUnsubscribeLink

---

Function Documentation

browserWatchView

(

)

customize browser title when viewing watches

Returns:

browser title

onUnwatch

(

)

called when user click on unsubscribe link

onUnwatchAll

(

)

called when user click on unsubscribe all link in watchViewBox

onUnwatchById

(

)

called when user click on unsubscribe link in watchViewBox

onWatch

(

)

called when user click on subscribe link

onWatchRecursively

(

)

called when user click on subscribe link in watchViewBox

watchViewBox

(

)

display list of nodes this user has subscribed to

Returns:

html blob

---