tx_opendocs Class Reference

Inheritance diagram for tx_opendocs:

[legend]Collaboration diagram for tx_opendocs:

[legend]List of all members.

Public Member Functions
	__construct (TYPO3backend &$backendReference=null)
	checkAccess ()
	loadDocsFromUserSession ()
	render ()
	renderMenu ()
	renderMenuEntry ($document, $md5sum, $isRecentDoc=false, $isFirstDoc=false)
	getAdditionalAttributes ()
	updateNumberOfOpenDocsHook (&$params, &$ref)
	closeDocument ($params=array(), TYPO3AJAX &$ajaxObj=null)
	renderAjax ($params=array(), TYPO3AJAX &$ajaxObj=null)
Protected Member Functions
	addJavascriptToBackend ()
	addCssToBackend ()
Protected Attributes
	$backendReference
	$openDocs
	$recentDocs
	$EXTKEY = 'opendocs'

---

Detailed Description

Definition at line 42 of file class.tx_opendocs.php.

---

Constructor & Destructor Documentation

tx_opendocs::__construct

(

TYPO3backend &$

backendReference = null

)

constructor, loads the documents from the user control

Parameters:

TYPO3backend

TYPO3 backend object reference

Implements backend_toolbarItem.

Definition at line 61 of file class.tx_opendocs.php.

References $backendReference, and loadDocsFromUserSession().

---

Member Function Documentation

tx_opendocs::addCssToBackend

(

)

[protected]

adds the neccessary CSS to the backend

Returns:

void

Definition at line 217 of file class.tx_opendocs.php.

References t3lib_extMgm::extRelPath().

Referenced by render().

tx_opendocs::addJavascriptToBackend

(

)

[protected]

adds the neccessary javascript to the backend

Returns:

void

Definition at line 208 of file class.tx_opendocs.php.

References t3lib_extMgm::extRelPath().

Referenced by render().

tx_opendocs::checkAccess

(

)

checks whether the user has access to this toolbar item

Returns:

boolean true if user has access, false if not

Implements backend_toolbarItem.

Definition at line 71 of file class.tx_opendocs.php.

References $GLOBALS.

tx_opendocs::closeDocument	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

closes a document in the session and

Parameters:

	array	array of parameters from the AJAX interface, currently unused
	TYPO3AJAX	object of type TYPO3AJAX

Returns:

string list item HTML attibutes

Definition at line 254 of file class.tx_opendocs.php.

References $ajaxObj, $GLOBALS, t3lib_div::_GP(), and renderAjax().

tx_opendocs::getAdditionalAttributes

(

)

returns additional attributes for the list item in the toolbar

Returns:

string list item HTML attibutes

Implements backend_toolbarItem.

Definition at line 199 of file class.tx_opendocs.php.

tx_opendocs::loadDocsFromUserSession

(

)

loads the opened and recently opened documents from the user

Returns:

void

Definition at line 81 of file class.tx_opendocs.php.

References $GLOBALS.

Referenced by __construct().

tx_opendocs::render

(

)

renders the toolbar item and the initial menu

Returns:

string the toolbar item including the initial menu content as HTML

Implements backend_toolbarItem.

Definition at line 91 of file class.tx_opendocs.php.

References $GLOBALS, addCssToBackend(), addJavascriptToBackend(), t3lib_extMgm::extRelPath(), renderMenu(), and t3lib_iconWorks::skinImg().

tx_opendocs::renderAjax	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

renders the menu so that it can be returned as response to an AJAX call

Parameters:

	array	array of parameters from the AJAX interface, currently unused
	TYPO3AJAX	object of type TYPO3AJAX

Returns:

void

Definition at line 287 of file class.tx_opendocs.php.

References $ajaxObj, and renderMenu().

Referenced by closeDocument().

tx_opendocs::renderMenu

(

)

renders the pure contents of the menu

Returns:

string the menu's content

Definition at line 116 of file class.tx_opendocs.php.

References $content, $GLOBALS, and renderMenuEntry().

Referenced by render(), and renderAjax().

tx_opendocs::renderMenuEntry	(	$	document,
		$	md5sum,
		$	isRecentDoc = false,
		$	isFirstDoc = false
	)

returns the recent documents list as an array

Returns:

array all recent documents as list-items

Definition at line 157 of file class.tx_opendocs.php.

References $GLOBALS, t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getRecordWSOL(), t3lib_div::htmlspecialchars_decode(), and t3lib_iconWorks::skinImg().

Referenced by renderMenu().

tx_opendocs::updateNumberOfOpenDocsHook	(	&$	params,
		&$	ref
	)

called as a hook in t3lib_BEfunc::setUpdateSignal, calls a JS function to change the number of opened documents

Parameters:

	array	$params
	unknown_type	$ref

Returns:

string list item HTML attibutes

Definition at line 234 of file class.tx_opendocs.php.

---

Member Data Documentation

tx_opendocs::$backendReference [protected]

Definition at line 49 of file class.tx_opendocs.php.

Referenced by __construct().

tx_opendocs::$EXTKEY = 'opendocs' [protected]

Definition at line 53 of file class.tx_opendocs.php.

tx_opendocs::$openDocs [protected]

Definition at line 51 of file class.tx_opendocs.php.

tx_opendocs::$recentDocs [protected]

Definition at line 52 of file class.tx_opendocs.php.

---

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

• typo3/sysext/opendocs/class.tx_opendocs.php

---