Inheritance diagram for TYPO3\CMS\Backend\ClickMenu\ClickMenu:

Public Member Functions
	init ()

	printDBClickMenu ($table, $uid)

	printNewDBLevel ($table, $uid)

	externalProcessingOfDBMenuItems ($menuItems)

	processingByExtClassArray ($menuItems, $table, $uid)

	urlRefForCM ($url, $retUrl='', $hideCM=1, $overrideLoc='')

	DB_copycut ($table, $uid, $type)

	DB_paste ($table, $uid, $type, $elInfo)

	DB_info ($table, $uid)

	DB_history ($table, $uid)

	DB_perms ($table, $uid, $rec)

	DB_db_list ($table, $uid, $rec)

	DB_moveWizard ($table, $uid, $rec)

	DB_newWizard ($table, $uid, $rec)

	DB_editAccess ($table, $uid)

	DB_editPageProperties ($uid)

	DB_edit ($table, $uid)

	DB_new ($table, $uid)

	DB_delete ($table, $uid, $elInfo)

	DB_view ($id, $anchor='')

	DB_tempMountPoint ($page_id)

	DB_hideUnhide ($table, $rec, $hideField)

	DB_changeFlag ($table, $rec, $flagField, $title, $name, $iconRelPath='gfx/')

	printFileClickMenu ($combinedIdentifier)

	externalProcessingOfFileMenuItems ($menuItems)

	FILE_launch ($path, $script, $type, $image, $noReturnUrl=FALSE)

	FILE_upload ($path)

	FILE_copycut ($path, $type)

	FILE_delete ($path)

	FILE_paste ($path, $target, $elInfo)

	printDragDropClickMenu ($table, $srcId, $dstId)

	externalProcessingOfDragDropMenuItems ($menuItems)

	dragDrop_copymovepage ($srcUid, $dstUid, $action, $into)

	dragDrop_copymovefolder ($srcPath, $dstPath, $action)

	printItems ($menuItems, $item)

	printLayerJScode ($menuItems)

	wrapColorTableCM ($str)

	menuItemsForTopFrame ($menuItems)

	menuItemsForClickMenu ($menuItems)

	addMenuItems ($menuItems, $newMenuItems, $position='')

	linkItem ($str, $icon, $onClick, $onlyCM=0, $dontHide=0)

	excludeIcon ($iconCode)

	enableDisableItems ($menuItems)

	cleanUpSpacers ($menuItems)

	label ($label)

	isCMlayers ()

	frameLocation ($str)

Public Attributes
	$cmLevel = 0

	$CB

	$backPath = ''

	$PH_backPath = '###BACK_PATH###'

	$listFrame = 0

	$isDBmenu = 0

	$alwaysContentFrame = 0

	$iParts = array()

	$disabledItems = array()

	$leftIcons = 0

	$extClassArray = array()

	$ajax = 0

	$elCount = 0

	$editPageIconSet = 0

	$editOK = 0

	$rec = array()

Protected Member Functions
	fileInfo ($identifier)

Detailed Description

Class for generating the click menu

Author: Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 30 of file ClickMenu.php.

Member Function Documentation

◆ addMenuItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::addMenuItems	(	$menuItems,
		$newMenuItems,
		$position = `''`
	)

Adds or inserts a menu item Can be used to set the position of new menu entries within the list of existing menu entries. Has this syntax: [cmd]:[menu entry key],[cmd].... cmd can be "after", "before" or "top" (or blank/"bottom" which is default). If "after"/"before" then menu items will be inserted after/before the existing entry with [menu entry key] if found. "after-spacer" and "before-spacer" do the same, but inserts before or after an item and a spacer. If not found, the bottom of list. If "top" the items are inserted in the top of the list.

Parameters

array	$menuItems	Menu items array
array	$newMenuItems	Menu items array to insert
string	$position	Position command string. Has this syntax: [cmd]:[menu entry key],[cmd].... cmd can be "after", "before" or "top" (or blank/"bottom" which is default). If "after"/"before" then menu items will be inserted after/before the existing entry with [menu entry key] if found. "after-spacer" and "before-spacer" do the same, but inserts before or after an item and a spacer. If not found, the bottom of list. If "top" the items are inserted in the top of the list.

Returns: array Menu items array, processed.

Todo:: Define visibility

Definition at line 1212 of file ClickMenu.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ cleanUpSpacers()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::cleanUpSpacers ( $menuItems )

Clean up spacers; Will remove any spacers in the start/end of menu items array plus any duplicates.

Parameters

array $menuItems Menu items array

Returns: array Menu items array, processed.

Todo:: Define visibility

Definition at line 1363 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printItems().

◆ DB_changeFlag()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_changeFlag	(	$table,
		$rec,
		$flagField,
		$title,
		$name,
		$iconRelPath = `'gfx/'`
	)

Adding CM element for a flag field of the input record

Parameters

string	$table	Table name
array	$rec	Record array
string	$flagField	Name of the flag field
string	$title	Menu item Title
string	$name	Name of the item used for icons and labels
string	$iconRelPath	Icon path relative to typo3/ folder

Returns: array Item array, element in $menuItems

Todo:: Define visibility

Definition at line 702 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\$rec, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), and TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken().

◆ DB_copycut()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_copycut	(	$table,
		$uid,
		$type
	)

Adding CM element for Clipboard "copy" and "cut"

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
string	$type	Type: "copy" or "cut

Returns: array Item array, element in $menuItems

Definition at line 390 of file ClickMenu.php.

References $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_db_list()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_db_list	(	$table,
		$uid,
		$rec
	)

Adding CM element for DBlist

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
array	$rec	Record of the element (needs "pid" field if not pages-record)

Returns: array Item array, element in $menuItems

Definition at line 491 of file ClickMenu.php.

◆ DB_delete()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_delete	(	$table,
		$uid,
		$elInfo
	)

Adding CM element for Delete

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
array	$elInfo	Label for including in the confirmation message, EXT:lang/locallang_core.xlf:mess.delete

Returns: array Item array, element in $menuItems

Definition at line 620 of file ClickMenu.php.

References $GLOBALS, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), and TYPO3\CMS\Backend\Utility\BackendUtility\translationCount().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_edit()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_edit	(	$table,
		$uid
	)

Adding CM element for regular editing of the element!

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Item array, element in $menuItems

Definition at line 571 of file ClickMenu.php.

References $GLOBALS, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), and TYPO3\CMS\Backend\Utility\BackendUtility\isModuleSetInTBE_MODULES().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_editAccess()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_editAccess	(	$table,
		$uid
	)

Adding CM element for Editing of the access related fields of a table (disable, starttime, endtime, fe_groups)

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Item array, element in $menuItems

Definition at line 543 of file ClickMenu.php.

References $GLOBALS, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\urlRefForCM().

◆ DB_editPageProperties()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_editPageProperties ( $uid )

Adding CM element for edit page properties

Parameters

integer $uid page uid to edit (PID)

Returns: array Item array, element in $menuItems

Definition at line 557 of file ClickMenu.php.

References $GLOBALS, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\urlRefForCM().

◆ DB_hideUnhide()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_hideUnhide	(	$table,
		$rec,
		$hideField
	)

Adding CM element for hide/unhide of the input record

Parameters

string	$table	Table name
array	$rec	Record array
string	$hideField	Name of the hide field

Returns: array Item array, element in $menuItems

Definition at line 686 of file ClickMenu.php.

◆ DB_history()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_history	(	$table,
		$uid
	)

Adding CM element for History

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Item array, element in $menuItems

Definition at line 448 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_info()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_info	(	$table,
		$uid
	)

Adding CM element for Info

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Item array, element in $menuItems

Definition at line 435 of file ClickMenu.php.

References $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\fileInfo(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_moveWizard()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_moveWizard	(	$table,
		$uid,
		$rec
	)

Adding CM element for Moving wizard

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
array	$rec	Record. Needed for tt-content elements which will have the sys_language_uid sent

Returns: array Item array, element in $menuItems

Definition at line 509 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\$rec, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\urlRefForCM().

◆ DB_new()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_new	(	$table,
		$uid
	)

Adding CM element for regular Create new element

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Item array, element in $menuItems

Definition at line 603 of file ClickMenu.php.

References $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_newWizard()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_newWizard	(	$table,
		$uid,
		$rec
	)

Adding CM element for Create new wizard (either db_new.php or sysext/cms/layout/db_new_content_el.php or custom wizard)

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
array	$rec	Record.

Returns: array Item array, element in $menuItems

Definition at line 525 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\$rec, $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Backend\Utility\BackendUtility\getModTSconfig(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\urlRefForCM().

◆ DB_paste()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_paste	(	$table,
		$uid,
		$type,
		$elInfo
	)

Adding CM element for Clipboard "paste into"/"paste after" NOTICE: $table and $uid should follow the special syntax for paste, see clipboard-class :: pasteUrl();

Parameters

string	$table	Table name
integer	$uid	UID for the current record. NOTICE: Special syntax!
string	$type	Type: "into" or "after
array	$elInfo	Contains instructions about whether to copy or cut an element.

Returns: array Item array, element in $menuItems

See also: ::pasteUrl()

Definition at line 414 of file ClickMenu.php.

References $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ DB_perms()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_perms	(	$table,
		$uid,
		$rec
	)

Adding CM element for Permission setting

Parameters

string	$table	Table name
integer	$uid	UID for the current record.
array	$rec	The "pages" record with "perms_*" fields inside.

Returns: array Item array, element in $menuItems

Definition at line 463 of file ClickMenu.php.

◆ DB_tempMountPoint()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_tempMountPoint ( $page_id )

Adding element for setting temporary mount point.

Parameters

integer $page_id Page uid (PID)

Returns: array Item array, element in $menuItems

Definition at line 655 of file ClickMenu.php.

◆ DB_view()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::DB_view	(	$id,
		$anchor = `''`
	)

Adding CM element for View Page

Parameters

integer	$id	Page uid (PID)
string	$anchor	Anchor, if any

Returns: array Item array, element in $menuItems

Definition at line 643 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu().

◆ dragDrop_copymovefolder()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::dragDrop_copymovefolder	(	$srcPath,
		$dstPath,
		$action
	)

Adding CM element for Copying/Moving a Folder Into from a drag & drop action

Parameters

string	$srcPath	source path for the record to modify
string	$dstPath	destination path for the records to modify
string	$action	Action code: either "move" or "copy

Returns: array Item array, element in $menuItems

Definition at line 1057 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu().

◆ dragDrop_copymovepage()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::dragDrop_copymovepage	(	$srcUid,
		$dstUid,
		$action,
		$into
	)

Adding CM element for Copying/Moving a Page Into/After from a drag & drop action

Parameters

integer	$srcUid	source UID code for the record to modify
integer	$dstUid	destination UID code for the record to modify
string	$action	Action code: either "move" or "copy @param string $into Parameter code: either "into" or "after

Returns: array Item array, element in $menuItems

Definition at line 1039 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu().

◆ enableDisableItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::enableDisableItems ( $menuItems )

Enabling / Disabling items based on list provided from GET var ($this->iParts[3])

Parameters

array $menuItems Menu items array

Returns: array Menu items array, processed.

Todo:: Define visibility

Definition at line 1325 of file ClickMenu.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printItems().

◆ excludeIcon()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::excludeIcon ( $iconCode )

Returns the input string IF not a user setting has disabled display of icons.

Parameters

string $iconCode The icon-image tag

Returns: string The icon-image tag prefixed with space char IF the icon should be printed at all due to user settings

Todo:: Define visibility

Definition at line 1314 of file ClickMenu.php.

References $GLOBALS.

◆ externalProcessingOfDBMenuItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::externalProcessingOfDBMenuItems ( $menuItems )

Processing the $menuItems array (for extension classes) (DATABASE RECORDS)

Parameters

array $menuItems Array for manipulation.

Returns: array Processed $menuItems array

Todo:: Define visibility

Definition at line 341 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu().

◆ externalProcessingOfDragDropMenuItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::externalProcessingOfDragDropMenuItems ( $menuItems )

Processing the $menuItems array (for extension classes) (DRAG'N DROP)

Parameters

array $menuItems Array for manipulation.

Returns: array Processed $menuItems array

Todo:: Define visibility

Definition at line 1024 of file ClickMenu.php.

◆ externalProcessingOfFileMenuItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::externalProcessingOfFileMenuItems ( $menuItems )

Processing the $menuItems array (for extension classes) (FILES)

Parameters

array $menuItems Array for manipulation.

Returns: array Processed $menuItems array

Todo:: Define visibility

Definition at line 855 of file ClickMenu.php.

◆ FILE_copycut()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::FILE_copycut	(	$path,
		$type
	)

Returns element for copy or cut of files.

Parameters

string	$path	Path to the file/directory (target)
string	$type	Type: "copy" or "cut

Returns: array Item array, element in $menuItems

Definition at line 901 of file ClickMenu.php.

References $uid, TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

◆ FILE_delete()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::FILE_delete ( $path )

Creates element for deleting of target

Parameters

string $path Path to the file/directory (target)

Returns: array Item array, element in $menuItems

Definition at line 923 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), and TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken().

◆ FILE_launch()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::FILE_launch	(	$path,
		$script,
		$type,
		$image,
		$noReturnUrl = `FALSE`
	)

Multi-function for adding an entry to the $menuItems array

Parameters

string	$path	Path to the file/directory (target)
string	$script	Script (eg. file_edit.php) to pass &target= to
string	$type	"type" is the code which fetches the correct label for the element from "cm. @param string $image icon image-filename from "gfx/" (12x12 icon)
boolean	$noReturnUrl	If set, the return URL parameter will not be set in the link

Returns: array Item array, element in $menuItems

Definition at line 871 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem(), and TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_upload().

◆ FILE_paste()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::FILE_paste	(	$path,
		$target,
		$elInfo
	)

Creates element for pasting files.

Parameters

string	$path	Path to the file/directory (target)
string	$target	target - NOT USED.
array	$elInfo	Various values for the labels.

Returns: array Item array, element in $menuItems

Definition at line 952 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\excludeIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\label(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\linkItem().

◆ FILE_upload()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::FILE_upload ( $path )

function for adding an upload entry to the $menuItems array

Parameters

string $path Path to the file/directory (target)

Returns: array Item array, element in $menuItems

Definition at line 885 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_launch().

◆ fileInfo()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::fileInfo ( $identifier )

protected

Adding ClickMenu element for file info

Parameters

string $identifier The combined identifier of the file.

Returns: array Item array, element in $menuItems

Definition at line 970 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_info().

◆ frameLocation()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::frameLocation ( $str )

Appends ".location" to input string

Parameters

string $str Input string, probably a JavaScript document reference

Returns: string

Todo:: Define visibility

Definition at line 1422 of file ClickMenu.php.

◆ init()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::init ( )

Initialize click menu

Returns: string The clickmenu HTML content

Todo:: Define visibility

Definition at line 139 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printFileClickMenu(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printNewDBLevel(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ isCMlayers()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::isCMlayers ( )

Returns TRUE if there should be writing to the div-layers (commands sent to clipboard MUST NOT write to div-layers)

Returns: boolean

Todo:: Define visibility

Definition at line 1411 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\$CB.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printLayerJScode().

◆ label()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::label ( $label )

Get label from locallang_core.xlf:cm.*

Parameters

string $label The "cm."-suffix to get.

Returns: string

Todo:: Define visibility

Definition at line 1401 of file ClickMenu.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_copycut(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_info(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_new(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_paste(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\dragDrop_copymovefolder(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\dragDrop_copymovepage(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_copycut(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_launch(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\FILE_paste().

◆ linkItem()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::linkItem	(	$str,
		$icon,
		$onClick,
		$onlyCM = `0`,
		$dontHide = `0`
	)

Creating an array with various elements for the clickmenu entry

Parameters

string	$str	The label, htmlspecialchar'ed already
string	$icon	-tag for the icon
string	$onClick	JavaScript onclick event for label/icon
boolean	$onlyCM	==1 and the element will NOT appear in clickmenus in the topframe (unless clickmenu is totally unavailable)! ==2 and the item will NEVER appear in top frame. (This is mostly for "less important" options since the top frame is not capable of holding so many elements horizontally)
boolean	$dontHide	If set, the clickmenu layer will not hide itself onclick - used for secondary menus to appear...

Returns: array $menuItem entry with 6 numerical entries: [0] is the HTML for display of the element with link and icon an mouseover etc., [1]-[5] is simply the input params passed through!

Todo:: Define visibility

Definition at line 1289 of file ClickMenu.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon().

◆ menuItemsForClickMenu()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::menuItemsForClickMenu ( $menuItems )

Traverses the menuItems and generates an output array for implosion in the CM div-layers table.

Parameters

array $menuItems Array

Returns: array array for implosion in the CM div-layers table.

Todo:: Define visibility

Definition at line 1174 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printLayerJScode().

◆ menuItemsForTopFrame()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::menuItemsForTopFrame ( $menuItems )

Traverses the menuItems and generates an output array for implosion in the topframe horizontal menu

Parameters

array $menuItems Array

Returns: array Array of menu items for top frame.

Todo:: Define visibility

Definition at line 1151 of file ClickMenu.php.

References $GLOBALS.

◆ printDBClickMenu()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printDBClickMenu	(	$table,
		$uid
	)

Make 1st level clickmenu:

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: string HTML content

Todo:: Define visibility

Definition at line 201 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\init().

◆ printDragDropClickMenu()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printDragDropClickMenu	(	$table,
		$srcId,
		$dstId
	)

Make 1st level clickmenu:

Parameters

string	$table	The absolute path
integer	$srcId	UID for the current record.
integer	$dstId	Destination ID

Returns: string HTML content

Todo:: Define visibility

Definition at line 988 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\dragDrop_copymovefolder(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\dragDrop_copymovepage(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\externalProcessingOfDBMenuItems(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIconForRecord(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printItems(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\processingByExtClassArray().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\init().

◆ printFileClickMenu()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printFileClickMenu ( $combinedIdentifier )

Make 1st level clickmenu:

Parameters

string $combinedIdentifier The combined identifier

Returns: string HTML content

See also: ::retrieveFileOrFolderObject()

Todo:: Define visibility

Definition at line 725 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\init().

◆ printItems()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printItems	(	$menuItems,
		$item
	)

Prints the items from input $menuItems array - as JS section for writing to the div-layers.

Parameters

array	$menuItems	Array
string	$item	HTML code for the element which was clicked - shown in the end of the horizontal menu in topframe after the close-button.

Returns: string HTML code

Todo:: Define visibility

Definition at line 1077 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\cleanUpSpacers(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\enableDisableItems(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\printLayerJScode().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\printNewDBLevel().

◆ printLayerJScode()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printLayerJScode ( $menuItems )

Create the JavaScript section

Parameters

array $menuItems The $menuItems array to print

Returns: string The JavaScript section which will print the content of the CM to the div-layer in the target frame.

Todo:: Define visibility

Definition at line 1096 of file ClickMenu.php.

References $GLOBALS, TYPO3\CMS\Backend\ClickMenu\ClickMenu\isCMlayers(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\menuItemsForClickMenu(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\wrapColorTableCM().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printItems().

◆ printNewDBLevel()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::printNewDBLevel	(	$table,
		$uid
	)

Make 2nd level clickmenu (only for DBmenus)

Parameters

string	$table	Table name
integer	$uid	UID for the current record.

Returns: string HTML content

Todo:: Define visibility

Definition at line 308 of file ClickMenu.php.

References $GLOBALS, $uid, TYPO3\CMS\Backend\Utility\BackendUtility\getRecordIconAltText(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIconForRecord(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printItems(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\processingByExtClassArray().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\init().

◆ processingByExtClassArray()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::processingByExtClassArray	(	$menuItems,
		$table,
		$uid
	)

Processing the $menuItems array by external classes (typ. adding items)

Parameters

array	$menuItems	Array for manipulation.
string	$table	Table name
integer	$uid	UID for the current record.

Returns: array Processed $menuItems array

Todo:: Define visibility

Definition at line 354 of file ClickMenu.php.

References $uid, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDBClickMenu(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\printDragDropClickMenu(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\printNewDBLevel().

◆ urlRefForCM()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::urlRefForCM	(	$url,
		$retUrl = `''`,
		$hideCM = `1`,
		$overrideLoc = `''`
	)

Returning JavaScript for the onClick event linking to the input URL.

Parameters

string	$url	The URL relative to TYPO3_mainDir
string	$retUrl	The return_url-parameter
boolean	$hideCM	If set, the "hideCM()" will be called
string	$overrideLoc	If set, gives alternative location to load in (for example top frame or somewhere else)

Returns: string JavaScript for an onClick event.

Todo:: Define visibility

Definition at line 374 of file ClickMenu.php.

References TYPO3\CMS\Backend\ClickMenu\ClickMenu\frameLocation().

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_editAccess(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_editPageProperties(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_moveWizard(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_newWizard().

◆ wrapColorTableCM()

TYPO3\CMS\Backend\ClickMenu\ClickMenu::wrapColorTableCM ( $str )

Wrapping the input string in a table with background color 4 and a black border style. For the pop-up menu

Parameters

string $str HTML content to wrap in table.

Returns: string

Todo:: Define visibility

Definition at line 1138 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\printLayerJScode().

Member Data Documentation

◆ $ajax

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$ajax = 0

Todo:: Define visibility

Definition at line 107 of file ClickMenu.php.

◆ $alwaysContentFrame

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$alwaysContentFrame = 0

Todo:: Define visibility

Definition at line 74 of file ClickMenu.php.

◆ $backPath

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$backPath = ''

Todo:: Define visibility

Definition at line 50 of file ClickMenu.php.

◆ $CB

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$CB

Todo:: Define visibility

Definition at line 43 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\isCMlayers().

◆ $cmLevel

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$cmLevel = 0

Todo:: Define visibility

Definition at line 37 of file ClickMenu.php.

◆ $disabledItems

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$disabledItems = array()

Todo:: Define visibility

Definition at line 89 of file ClickMenu.php.

◆ $editOK

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$editOK = 0

Todo:: Define visibility

Definition at line 126 of file ClickMenu.php.

◆ $editPageIconSet

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$editPageIconSet = 0

Todo:: Define visibility

Definition at line 120 of file ClickMenu.php.

◆ $elCount

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$elCount = 0

Todo:: Define visibility

Definition at line 114 of file ClickMenu.php.

◆ $extClassArray

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$extClassArray = array()

Todo:: Define visibility

Definition at line 101 of file ClickMenu.php.

◆ $iParts

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$iParts = array()

Todo:: Define visibility

Definition at line 83 of file ClickMenu.php.

◆ $isDBmenu

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$isDBmenu = 0

Todo:: Define visibility

Definition at line 68 of file ClickMenu.php.

◆ $leftIcons

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$leftIcons = 0

Todo:: Define visibility

Definition at line 95 of file ClickMenu.php.

◆ $listFrame

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$listFrame = 0

Todo:: Define visibility

Definition at line 62 of file ClickMenu.php.

◆ $PH_backPath

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$PH_backPath = '###BACK_PATH###'

Todo:: Define visibility

Definition at line 56 of file ClickMenu.php.

◆ $rec

TYPO3\CMS\Backend\ClickMenu\ClickMenu::$rec = array()

Todo:: Define visibility

Definition at line 131 of file ClickMenu.php.

Referenced by TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_changeFlag(), TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_moveWizard(), and TYPO3\CMS\Backend\ClickMenu\ClickMenu\DB_newWizard().

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addMenuItems()

◆ cleanUpSpacers()

◆ DB_changeFlag()

◆ DB_copycut()

◆ DB_db_list()

◆ DB_delete()

◆ DB_edit()

◆ DB_editAccess()

◆ DB_editPageProperties()

◆ DB_hideUnhide()

◆ DB_history()

◆ DB_info()

◆ DB_moveWizard()

◆ DB_new()

◆ DB_newWizard()

◆ DB_paste()

◆ DB_perms()

◆ DB_tempMountPoint()

◆ DB_view()

◆ dragDrop_copymovefolder()

◆ dragDrop_copymovepage()

◆ enableDisableItems()

◆ excludeIcon()

◆ externalProcessingOfDBMenuItems()

◆ externalProcessingOfDragDropMenuItems()

◆ externalProcessingOfFileMenuItems()

◆ FILE_copycut()

◆ FILE_delete()

◆ FILE_launch()

◆ FILE_paste()

◆ FILE_upload()

◆ fileInfo()

◆ frameLocation()

◆ init()

◆ isCMlayers()

◆ label()

◆ linkItem()

◆ menuItemsForClickMenu()

◆ menuItemsForTopFrame()

◆ printDBClickMenu()

◆ printDragDropClickMenu()

◆ printFileClickMenu()

◆ printItems()

◆ printLayerJScode()

◆ printNewDBLevel()

◆ processingByExtClassArray()

◆ urlRefForCM()

◆ wrapColorTableCM()

Member Data Documentation

◆ $ajax

◆ $alwaysContentFrame

◆ $backPath

◆ $CB

◆ $cmLevel

◆ $disabledItems

◆ $editOK

◆ $editPageIconSet

◆ $elCount

◆ $extClassArray

◆ $iParts

◆ $isDBmenu

◆ $leftIcons

◆ $listFrame

◆ $PH_backPath

◆ $rec