ShortcutMenu Klassenreferenz

Klassendiagramm für ShortcutMenu:

Aufstellung aller Elemente

Öffentliche Methoden
	__construct (TYPO3backend &$backendReference=null)
	checkAccess ()
	render ()
	renderMenu ()
	renderAjax ($params=array(), TYPO3AJAX &$ajaxObj=null)
	getAdditionalAttributes ()
	getAjaxShortcutGroups ($params=array(), TYPO3AJAX &$ajaxObj=null)
	deleteAjaxShortcut ($params=array(), TYPO3AJAX &$ajaxObj=null)
	createAjaxShortcut ($params=array(), TYPO3AJAX &$ajaxObj=null)
	setAjaxShortcut ($params=array(), TYPO3AJAX &$ajaxObj=null)
Geschützte Methoden
	addJavascriptToBackend ()
	initShortcuts ()
	getShortcutsByGroup ($groupId)
	getShortcutById ($shortcutId)
	initShortcutGroups ($params=array(), TYPO3AJAX &$ajaxObj=null)
	getShortcutGroupLabel ($groupId)
	getGlobalShortcutGroups ()
	getGroupsFromShortcuts ()
	getShortcutIcon ($row, $shortcut)
	getShortcutIconTitle ($shortcutLabel, $moduleName, $parentModuleName= '')
	getLinkedPageId ($url)
Geschützte Attribute
	$shortcutGroups
	$shortcuts
	$groupLabels
	$backendReference

---

Beschreibung der Konstruktoren und Destruktoren

ShortcutMenu::__construct

(

TYPO3backend &$

backendReference = null

)

constructor

Parameter:

TYPO3backend

TYPO3 backend object reference

Rückgabe:

void

Implementiert backend_toolbarItem.

---

Dokumentation der Elementfunktionen

ShortcutMenu::addJavascriptToBackend

(

)

[protected]

adds the necessary JavaScript to the backend

Rückgabe:

void

ShortcutMenu::checkAccess

(

)

checks whether the user has access to this toolbar item

Rückgabe:

boolean true if user has access, false if not

Implementiert backend_toolbarItem.

ShortcutMenu::createAjaxShortcut	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

creates a shortcut through an AJAX call

Parameter:

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

Rückgabe:

void

ShortcutMenu::deleteAjaxShortcut	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

deletes a shortcut through an AJAX call

Parameter:

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

Rückgabe:

void

ShortcutMenu::getAdditionalAttributes

(

)

returns additional attributes for the list item in the toolbar

Rückgabe:

string list item HTML attibutes

Implementiert backend_toolbarItem.

ShortcutMenu::getAjaxShortcutGroups	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

gets the available shortcut groups

Parameter:

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

Rückgabe:

void

ShortcutMenu::getGlobalShortcutGroups

(

)

[protected]

gets a list of global groups, shortcuts in these groups are available to all users

Rückgabe:

array array of global groups

ShortcutMenu::getGroupsFromShortcuts

(

)

[protected]

runs through the available shortcuts an collects their groups

Rückgabe:

array array of groups which have shortcuts

ShortcutMenu::getLinkedPageId

(

$

url

)

[protected]

Return the ID of the page in the URL if found.

Parameter:

string

The URL of the current shortcut link

Rückgabe:

string If a page ID was found, it is returned. Otherwise: 0

ShortcutMenu::getShortcutById

(

$

shortcutId

)

[protected]

gets a shortcut by its uid

Parameter:

integer

shortcut id to get the complete shortcut for

Rückgabe:

mixed an array containing the shortcut's data on success or false on failure

ShortcutMenu::getShortcutGroupLabel

(

$

groupId

)

[protected]

gets the label for a shortcut group

Parameter:

integer

a shortcut group id

Rückgabe:

string the shortcut group label, can be an empty string if no group was found for the id

ShortcutMenu::getShortcutIcon	(	$	row,
		$	shortcut
	)			[protected]

gets the icon for the shortcut

Parameter:

string

backend module name

Rückgabe:

string shortcut icon as img tag

ShortcutMenu::getShortcutIconTitle	(	$	shortcutLabel,
		$	moduleName,
		$	parentModuleName = ''
	)			[protected]

Returns title for the shortcut icon

Parameter:

	string	shortcut label
	string	backend module name (key)
	string	parent module label

Rückgabe:

string title for the shortcut icon

ShortcutMenu::getShortcutsByGroup

(

$

groupId

)

[protected]

gets shortcuts for a specific group

Parameter:

integer

group Id

Rückgabe:

array array of shortcuts that matched the group

ShortcutMenu::initShortcutGroups	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)			[protected]

gets the available shortcut groups from default gropups, user TSConfig, and global groups

Parameter:

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

Rückgabe:

array

ShortcutMenu::initShortcuts

(

)

[protected]

retrieves the shortcuts for the current user

Rückgabe:

array array of shortcuts

ShortcutMenu::render

(

)

Creates the shortcut menu (default renderer)

Rückgabe:

string workspace selector as HTML select

Implementiert backend_toolbarItem.

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

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

Parameter:

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

Rückgabe:

void

ShortcutMenu::renderMenu

(

)

renders the pure contents of the menu

Rückgabe:

string the menu's content

ShortcutMenu::setAjaxShortcut	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

gets called when a shortcut is changed, checks whether the user has permissions to do so and saves the changes if everything is ok

Parameter:

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

Rückgabe:

void

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/classes/class.shortcutmenu.php