JsupdaterController Class Reference

Inheritance diagram for JsupdaterController:

Collaboration diagram for JsupdaterController:

Public Member Functions
	get_action ()
	mark_notification_read_action ($id)
	notifications_seen_action ()
Public Member Functions inherited from AuthenticatedController
	before_filter (&$action, &$args)
	after_filter ($action, $args)
Public Member Functions inherited from StudipController
	validate_args (&$args, $types=NULL)
	url_for ($to)
	rescue ($exception)
	setInfoBoxImage ($image)
	addToInfobox ($category, $text, $icon= 'blank.gif')

Protected Member Functions
	coreInformation ()
	recursive_studip_utf8encode (array $data)

Detailed Description

Controller called by the main periodical ajax-request. It collects data, converts the textstrings to utf8 and returns it as a json-object to the javascript-function "STUDIP.JSUpdater.processUpdate(json)".

Member Function Documentation

coreInformation ( )

protected

SystemPlugins may call UpdateInformation::setInformation to set information to be sent via ajax to the main request. Core-functionality-data should be collected and set here.

Returns

array: array(array('js_function' => $data), ...)

Here is the call graph for this function:

Here is the caller graph for this function:

get_action

(

)

Main action that returns a json-object like { 'js_function.sub_function': data, 'anotherjs_function.sub_function': moredata } This action is called by STUDIP.JSUpdater.call and the result processed by STUDIP.JSUpdater.processUpdate

Here is the call graph for this function:

mark_notification_read_action

(

$id

)

Marks a personal notification as read by the user so it won't be displayed in the list in the header.

Parameters

string

$id

: hash-id of the notification

Here is the call graph for this function:

notifications_seen_action

(

)

Sets the background-color of the notification-number to blue, so it does not annoy the user anymore. But he/she is still able to see the notificaion-list. Just sets a unix-timestamp in the user-config NOTIFICATIONS_SEEN_LAST_DATE.

Here is the call graph for this function:

recursive_studip_utf8encode ( array  $data )

protected

Converts all strings within an array (except for indexes) from windows 1252 to utf8. PHP-objects are ignored.

Parameters

array

$data,:

any array with strings in windows-1252 encoded

Returns

array: almost the same array but strings are now utf8-encoded

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• app/controllers/jsupdater.php