clickMenu Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden

 init ()
 doDisplayTopFrameCM ()
 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_editPageHeader ($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 ($path)
 externalProcessingOfFileMenuItems ($menuItems)
 FILE_launch ($path, $script, $type, $image, $noReturnUrl=FALSE)
 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)

Öffentliche Attribute

 $cmLevel = 0
 $CB
 $backPath = ''
 $PH_backPath = '###BACK_PATH###'
 $listFrame = 0
 $isDBmenu = 0
 $alwaysContentFrame = 0
 $iParts = array()
 $disabledItems = array()
 $dontDisplayTopFrameCM = 0
 $leftIcons = 0
 $extClassArray = array()
 $ajax = 0
 $elCount = 0
 $editPageIconSet = 0
 $editOK = 0
 $rec = array()

Dokumentation der Elementfunktionen

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.

Parameter:
array Menu items array
array Menu items array to insert
string 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.
Rückgabe:
array Menu items array, processed.
clickMenu::cleanUpSpacers ( $  menuItems  ) 

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

Parameter:
array Menu items array
Rückgabe:
array Menu items array, processed.
clickMenu::DB_changeFlag ( $  table,
$  rec,
$  flagField,
$  title,
$  name,
$  iconRelPath = 'gfx/' 
)

Adding CM element for a flag field of the input record

Parameter:
string Table name
array Record array
string Name of the flag field
string Menu item Title
string Name of the item used for icons and labels
string Icon path relative to typo3/ folder
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_copycut ( $  table,
$  uid,
$  type 
)

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

Parameter:
string Table name
integer UID for the current record.
string Type: "copy" or "cut"
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_db_list ( $  table,
$  uid,
$  rec 
)

Adding CM element for DBlist

Parameter:
string Table name
integer UID for the current record.
array Record of the element (needs "pid" field if not pages-record)
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_delete ( $  table,
$  uid,
$  elInfo 
)

Adding CM element for Delete

Parameter:
string Table name
integer UID for the current record.
array Label for including in the confirmation message, EXT:lang/locallang_core.php:mess.delete
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_edit ( $  table,
$  uid 
)

Adding CM element for regular editing of the element!

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_editAccess ( $  table,
$  uid 
)

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

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_editPageHeader ( $  uid  ) 

Adding CM element for edit page header

Parameter:
integer page uid to edit (PID)
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_editPageProperties ( $  uid  ) 

Adding CM element for edit page properties

Parameter:
integer page uid to edit (PID)
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_hideUnhide ( $  table,
$  rec,
$  hideField 
)

Adding CM element for hide/unhide of the input record

Parameter:
string Table name
array Record array
string Name of the hide field
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_history ( $  table,
$  uid 
)

Adding CM element for History

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_info ( $  table,
$  uid 
)

Adding CM element for Info

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_moveWizard ( $  table,
$  uid,
$  rec 
)

Adding CM element for Moving wizard

Parameter:
string Table name
integer UID for the current record.
array Record. Needed for tt-content elements which will have the sys_language_uid sent
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_new ( $  table,
$  uid 
)

Adding CM element for regular Create new element

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
array Item array, element in $menuItems
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)

Parameter:
string Table name
integer UID for the current record.
array Record.
Rückgabe:
array Item array, element in $menuItems
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();

Parameter:
string Table name
integer UID for the current record. NOTICE: Special syntax!
string Type: "into" or "after"
array Contains instructions about whether to copy or cut an element.
Rückgabe:
array Item array, element in $menuItems
Siehe auch:
t3lib_clipboard::pasteUrl()
clickMenu::DB_perms ( $  table,
$  uid,
$  rec 
)

Adding CM element for Permission setting

Parameter:
string Table name
integer UID for the current record.
array The "pages" record with "perms_*" fields inside.
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_tempMountPoint ( $  page_id  ) 

Adding element for setting temporary mount point.

Parameter:
integer Page uid (PID)
Rückgabe:
array Item array, element in $menuItems
clickMenu::DB_view ( $  id,
$  anchor = '' 
)

Adding CM element for View Page

Parameter:
integer Page uid (PID)
string Anchor, if any
Rückgabe:
array Item array, element in $menuItems
clickMenu::doDisplayTopFrameCM (  ) 

Returns true if the menu should (also?) be displayed in topframe, not just

-layers
Rückgabe:
boolean
clickMenu::dragDrop_copymovefolder ( $  srcPath,
$  dstPath,
$  action 
)

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

Parameter:
string source path for the record to modify
string destination path for the records to modify
string Action code: either "move" or "copy"
Rückgabe:
array Item array, element in $menuItems
clickMenu::dragDrop_copymovepage ( $  srcUid,
$  dstUid,
$  action,
$  into 
)

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

Parameter:
integer source UID code for the record to modify
integer destination UID code for the record to modify
string Action code: either "move" or "copy"
string Parameter code: either "into" or "after"
Rückgabe:
array Item array, element in $menuItems
clickMenu::enableDisableItems ( $  menuItems  ) 

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

Parameter:
array Menu items array
Rückgabe:
array Menu items array, processed.
clickMenu::excludeIcon ( $  iconCode  ) 

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

Parameter:
string The icon-image tag
Rückgabe:
string The icon-image tag prefixed with space char IF the icon should be printed at all due to user settings
clickMenu::externalProcessingOfDBMenuItems ( $  menuItems  ) 

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

Parameter:
array $menuItems array for manipulation.
Rückgabe:
array Processed $menuItems array
clickMenu::externalProcessingOfDragDropMenuItems ( $  menuItems  ) 

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

Parameter:
array $menuItems array for manipulation.
Rückgabe:
array Processed $menuItems array
clickMenu::externalProcessingOfFileMenuItems ( $  menuItems  ) 

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

Parameter:
array $menuItems array for manipulation.
Rückgabe:
array Processed $menuItems array
clickMenu::FILE_copycut ( $  path,
$  type 
)

Returns element for copy or cut of files.

Parameter:
string Path to the file/directory (target)
string Type: "copy" or "cut"
Rückgabe:
array Item array, element in $menuItems
clickMenu::FILE_delete ( $  path  ) 

Creates element for deleting of target

Parameter:
string Path to the file/directory (target)
Rückgabe:
array Item array, element in $menuItems
clickMenu::FILE_launch ( $  path,
$  script,
$  type,
$  image,
$  noReturnUrl = FALSE 
)

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

Parameter:
string Path to the file/directory (target)
string Script (eg. file_edit.php) to pass &target= to
string "type" is the code which fetches the correct label for the element from "cm."
string icon image-filename from "gfx/" (12x12 icon)
boolean If set, the return URL parameter will not be set in the link
Rückgabe:
array Item array, element in $menuItems
clickMenu::FILE_paste ( $  path,
$  target,
$  elInfo 
)

Creates element for pasting files.

Parameter:
string Path to the file/directory (target)
string target - NOT USED.
array Various values for the labels.
Rückgabe:
array Item array, element in $menuItems
clickMenu::frameLocation ( $  str  ) 

Appends ".location" to input string

Parameter:
string Input string, probably a JavaScript document reference
Rückgabe:
string
clickMenu::init (  ) 

Initialize click menu

Rückgabe:
string The clickmenu HTML content
clickMenu::isCMlayers (  ) 

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

Rückgabe:
boolean
clickMenu::label ( $  label  ) 

Get label from locallang_core.php:cm.*

Parameter:
string The "cm."-suffix to get.
Rückgabe:
string
clickMenu::linkItem ( $  str,
$  icon,
$  onClick,
$  onlyCM = 0,
$  dontHide = 0 
)

Creating an array with various elements for the clickmenu entry

Parameter:
string The label, htmlspecialchar'ed already
string -tag for the icon
string JavaScript onclick event for label/icon
boolean ==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 If set, the clickmenu layer will not hide itself onclick - used for secondary menus to appear...
Rückgabe:
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!
clickMenu::menuItemsForClickMenu ( $  menuItems  ) 

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

Parameter:
array $menuItem array
array Array with HTML content to be imploded between

-tags

Rückgabe:
array array for implosion in the CM div-layers table.
clickMenu::menuItemsForTopFrame ( $  menuItems  ) 

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

Parameter:
array $menuItem array
array Array with HTML content to be imploded between

-tags

Rückgabe:
array Array of menu items for top frame.
clickMenu::printDBClickMenu ( $  table,
$  uid 
)

Make 1st level clickmenu:

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
string HTML content
clickMenu::printDragDropClickMenu ( $  table,
$  srcId,
$  dstId 
)

Make 1st level clickmenu:

Parameter:
string The absolute path
integer UID for the current record.
integer Destination ID
Rückgabe:
string HTML content
clickMenu::printFileClickMenu ( $  path  ) 

Make 1st level clickmenu:

Parameter:
string The absolute path
Rückgabe:
string HTML content
clickMenu::printItems ( $  menuItems,
$  item 
)

Prints the items from input $menuItems array - both as topframe menu AND the JS section for writing to the div-layers. Of course the topframe menu will appear only if $this->doDisplayTopFrameCM() returns true

Parameter:
array $menuItems array
string HTML code for the element which was clicked - shown in the end of the horizontal menu in topframe after the close-button.
Rückgabe:
string HTML code
clickMenu::printLayerJScode ( $  menuItems  ) 

Create the JavaScript section

Parameter:
array The $menuItems array to print
Rückgabe:
string The JavaScript section which will print the content of the CM to the div-layer in the target frame.
clickMenu::printNewDBLevel ( $  table,
$  uid 
)

Make 2nd level clickmenu (only for DBmenus)

Parameter:
string Table name
integer UID for the current record.
Rückgabe:
string HTML content
clickMenu::processingByExtClassArray ( $  menuItems,
$  table,
$  uid 
)

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

Parameter:
array $menuItems array for manipulation.
string Table name
integer UID for the current record.
Rückgabe:
array Processed $menuItems array
clickMenu::urlRefForCM ( $  url,
$  retUrl = '',
$  hideCM = 1,
$  overrideLoc = '' 
)

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

Parameter:
string The URL relative to TYPO3_mainDir
string The return_url-parameter
boolean If set, the "hideCM()" will be called
string If set, gives alternative location to load in (for example top frame or somewhere else)
Rückgabe:
string JavaScript for an onClick event.
clickMenu::wrapColorTableCM ( $  str  ) 

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

Parameter:
string HTML content to wrap in table.
Rückgabe:
string
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
 Alle Klassen Namensbereiche Funktionen Variablen
Erzeugt am Wed Oct 28 16:40:21 2009 für Typo3 von  doxygen 1.6.1