t3lib_clipboard Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	initializeClipboard ()
	lockToNormal ()
	setCmd ($cmd)
	setCurrentPad ($padIdent)
	endClipboard ()
	cleanUpCBC ($CBarr, $table, $removeDeselected=0)
	printClipboard ()
	printContentFromTab ($pad)
	padTitleWrap ($str, $pad)
	linkItemText ($str, $rec, $table='')
	selUrlDB ($table, $uid, $copy=0, $deselect=0, $baseArray=array())
	selUrlFile ($path, $copy=0, $deselect=0, $baseArray=array())
	pasteUrl ($table, $uid, $setRedirect=1)
	deleteUrl ($setRedirect=1, $file=0)
	editUrl ()
	removeUrl ($table, $uid)
	confirmMsg ($table, $rec, $type, $clElements)
	clLabel ($key, $Akey='labels')
	exportClipElementParameters ()
	removeElement ($el)
	saveClipboard ()
	currentMode ()
	cleanCurrent ()
	elFromTable ($matchTable='', $pad='')
	isSelected ($table, $uid)
	getSelectedRecord ($table='', $uid='')
	isElements ()
	makePasteCmdArray ($ref, $CMD)
	makeDeleteCmdArray ($CMD)
	makePasteCmdArray_file ($ref, $FILE)
	makeDeleteCmdArray_file ($FILE)
Öffentliche Attribute
	$numberTabs = 3
	$clipData = array()
	$changed = 0
	$current = ''
	$backPath = ''
	$lockToNormal = 0
	$fileMode = 0

---

Dokumentation der Elementfunktionen

t3lib_clipboard::cleanCurrent

(

)

This traverses the elements on the current clipboard pane and unsets elements which does not exist anymore or are disabled.

Rückgabe:

void

t3lib_clipboard::cleanUpCBC	(	$	CBarr,
		$	table,
		$	removeDeselected = 0
	)

Cleans up an incoming element array $CBarr (Array selecting/deselecting elements)

Parameter:

	array	Element array from outside ("key" => "selected/deselected")
	string	$table is the 'table which is allowed'. Must be set.
	boolean	$removeDeselected can be set in order to remove entries which are marked for deselection.

Rückgabe:

array Processed input $CBarr

t3lib_clipboard::clLabel	(	$	key,
		$	Akey = 'labels'
	)

Clipboard label - getting from "EXT:lang/locallang_core.php:"

Parameter:

	string	Label Key
	string	Alternative key to "labels"

Rückgabe:

string

t3lib_clipboard::confirmMsg	(	$	table,
		$	rec,
		$	type,
		$	clElements
	)

Returns confirm JavaScript message

Parameter:

	string	Table name
	mixed	For records its an array, for files its a string (path)
	string	Type-code
	array	Array of selected elements

Rückgabe:

string JavaScript "confirm" message

t3lib_clipboard::currentMode

(

)

Returns the current mode, 'copy' or 'cut'

Rückgabe:

string "copy" or "cut"

t3lib_clipboard::deleteUrl	(	$	setRedirect = 1,
		$	file = 0
	)

deleteUrl for current pad

Parameter:

	boolean	If set, then the redirect URL will point back to the current script, but with CB reset.
	boolean	If set, then the URL will link to the tce_file.php script in the typo3/ dir.

Rückgabe:

string

t3lib_clipboard::editUrl

(

)

editUrl of all current elements ONLY database Links to alt_doc.php

Rückgabe:

string The URL to alt_doc.php with parameters.

t3lib_clipboard::elFromTable	(	$	matchTable = '',
		$	pad = ''
	)

Counts the number of elements from the table $matchTable. If $matchTable is blank, all tables (except '_FILE' of course) is counted.

Parameter:

	string	Table to match/count for.
	string	$pad can optionally be used to set another pad than the current.

Rückgabe:

array Array with keys from the CB.

t3lib_clipboard::endClipboard

(

)

Call this after initialization and setCmd in order to save the clipboard to the user session. The function will check if the internal flag ->changed has been set and if so, save the clipboard. Else not.

Rückgabe:

void

t3lib_clipboard::exportClipElementParameters

(

)

Creates GET parameters for linking to the export module.

Rückgabe:

string GET parameters for current clipboard content to be exported.

t3lib_clipboard::getSelectedRecord	(	$	table = '',
		$	uid = ''
	)

Returns item record $table,$uid if selected on current clipboard If table and uid is blank, the first element is returned. Makes sense only for DB records - not files!

Parameter:

	string	Table name
	integer	Element uid

Rückgabe:

array Element record with extra field _RECORD_TITLE set to the title of the record...

t3lib_clipboard::initializeClipboard

(

)

Initialize the clipboard from the be_user session

Rückgabe:

void

t3lib_clipboard::isElements

(

)

Reports if the current pad has elements (does not check file/DB type OR if file/DBrecord exists or not. Only counting array)

Rückgabe:

boolean True if elements exist.

t3lib_clipboard::isSelected	(	$	table,
		$	uid
	)

Verifies if the item $table/$uid is on the current pad. If the pad is "normal", the mode value is returned if the element existed. Thus you'll know if the item was copy or cut moded...

Parameter:

	string	Table name, (_FILE for files...)
	integer	Element uid (path for files)

Rückgabe:

string

t3lib_clipboard::linkItemText	(	$	str,
		$	rec,
		$	table = ''
	)

Wraps the title of the items listed in link-tags. The items will link to the page/folder where they originate from

Parameter:

	string	Title of element - must be htmlspecialchar'ed on beforehand.
	mixed	If array, a record is expected. If string, its a path
	string	Table name

Rückgabe:

string

t3lib_clipboard::lockToNormal

(

)

Call this method after initialization if you want to lock the clipboard to operate on the normal pad only. Trying to switch pad through ->setCmd will not work This is used by the clickmenu since it only allows operation on single elements at a time (that is the "normal" pad)

Rückgabe:

void

t3lib_clipboard::makeDeleteCmdArray

(

$

CMD

)

Delete record entries in CMD array

Parameter:

array

Command-array

Rückgabe:

array Modified Command-array

t3lib_clipboard::makeDeleteCmdArray_file

(

$

FILE

)

Delete files in CMD array

Parameter:

array

Command-array

Rückgabe:

array Modified Command-array

t3lib_clipboard::makePasteCmdArray	(	$	ref,
		$	CMD
	)

Applies the proper paste configuration in the $cmd array send to tce_db.php. $ref is the target, see description below. The current pad is pasted

$ref: [tablename]:[paste-uid]. tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid. No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though. so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record 'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30 ':30' means 'paste ALL database elements on the clipboard into page with id 30 ':-30' not valid.

Parameter:

	string	[tablename]:[paste-uid], see description
	array	Command-array

Rückgabe:

array Modified Command-array

t3lib_clipboard::makePasteCmdArray_file	(	$	ref,
		$	FILE
	)

Applies the proper paste configuration in the $file array send to tce_file.php. The current pad is pasted

Parameter:

	string	Reference to element (splitted by "|")
	array	Command-array

Rückgabe:

array Modified Command-array

t3lib_clipboard::padTitleWrap	(	$	str,
		$	pad
	)

Wraps title of pad in bold-tags and maybe the number of elements if any.

Parameter:

	string	String (already htmlspecialchars()'ed)
	string	Pad reference

Rückgabe:

string HTML output (htmlspecialchar'ed content inside of tags.)

t3lib_clipboard::pasteUrl	(	$	table,
		$	uid,
		$	setRedirect = 1
	)

pasteUrl of the element (database and file) For the meaning of $table and $uid, please read from ->makePasteCmdArray!!! The URL will point to tce_file or tce_db depending in $table

Parameter:

	string	Tablename (_FILE for files)
	mixed	"destination": can be positive or negative indicating how the paste is done (paste into / paste after)
	boolean	If set, then the redirect URL will point back to the current script, but with CB reset.

Rückgabe:

string

t3lib_clipboard::printClipboard

(

)

Prints the clipboard

Rückgabe:

string HTML output

t3lib_clipboard::printContentFromTab

(

$

pad

)

Print the content on a pad. Called from ->printClipboard()

Parameter:

string

Pad reference

Rückgabe:

array Array with table rows for the clipboard. private

t3lib_clipboard::removeElement

(

$

el

)

Removes element on clipboard

Parameter:

string

Key of element in ->clipData array

Rückgabe:

void

t3lib_clipboard::removeUrl	(	$	table,
		$	uid
	)

Returns the remove-url (file and db) for file $table='_FILE' and $uid = shortmd5 hash of path

Parameter:

	string	Tablename
	string	uid integer/shortmd5 hash

Rückgabe:

string URL

t3lib_clipboard::saveClipboard

(

)

Saves the clipboard, no questions asked. Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)

Rückgabe:

void private

t3lib_clipboard::selUrlDB	(	$	table,
		$	uid,
		$	copy = 0,
		$	deselect = 0,
		$	baseArray = array()
	)

Returns the select-url for database elements

Parameter:

	string	Table name
	integer	Uid of record
	boolean	If set, copymode will be enabled
	boolean	If set, the link will deselect, otherwise select.
	array	The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.

Rückgabe:

string URL linking to the current script but with the CB array set to select the element with table/uid

t3lib_clipboard::selUrlFile	(	$	path,
		$	copy = 0,
		$	deselect = 0,
		$	baseArray = array()
	)

Returns the select-url for files

Parameter:

	string	Filepath
	boolean	If set, copymode will be enabled
	boolean	If set, the link will deselect, otherwise select.
	array	The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.

Rückgabe:

string URL linking to the current script but with the CB array set to select the path

t3lib_clipboard::setCmd

(

$

cmd

)

The array $cmd may hold various keys which notes some action to take. Normally perform only one action at a time. In scripts like db_list.php / file_list.php the GET-var CB is used to control the clipboard.

Selecting / Deselecting elements Array $cmd['el'] has keys = element-ident, value = element value (see description of clipData array in header) Selecting elements for 'copy' should be done by simultaneously setting setCopyMode.

Parameter:

array

Array of actions, see function description

Rückgabe:

void

t3lib_clipboard::setCurrentPad

(

$

padIdent

)

Setting the current pad on clipboard

Parameter:

string

Key in the array $this->clipData

Rückgabe:

void

---

Dokumentation der Datenelemente

t3lib_clipboard::$clipData = array()

Clipboard data kept here

Keys: 'normal' 'tab_[x]' where x is >=1 and denotes the pad-number \ 'mode' : 'copy' means copy-mode, default = moving ('cut') \ 'el' : Array of elements: DB: keys = '[tablename]|[uid]' eg. 'tt_content:123' DB: values = 1 (basically insignificant) FILE: keys = '_FILE|[shortmd5 of path]' eg. '_FILE|9ebc7e5c74' FILE: values = The full filepath, eg. '/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php' or 'C:/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php'

'current' pointer to current tab (among the above...) '_setThumb' boolean: If set, file thumbnails are shown.

The virtual tablename '_FILE' will always indicate files/folders. When checking for elements from eg. 'all tables' (by using an empty string) '_FILE' entries are excluded (so in effect only DB elements are counted)

---

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

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_clipboard.php