browse_links Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden

 init ()
 processSessionData ($data)
 main_rte ($wiz=0)
 main_db ()
 main_file ()
 main_folder ()
 expandPage ()
 TBE_expandPage ($tables)
 TBE_expandSubFolders ($expandFolder=0)
 expandFolder ($expandFolder=0, $extensionList='')
 TBE_expandFolder ($expandFolder=0, $extensionList='', $noThumbs=0)
 fileList ($files, $folderName='', $noThumbs=0)
 folderList ($baseFolder, $folders)
 TBE_dragNDrop ($expandFolder=0, $extensionList='')
 isWebFolder ($folder)
 checkFolder ($folder)
 isReadOnlyFolder ($folder)
 barheader ($str)
 getMsgBox ($in_msg, $icon='icon_note')
 printCurrentUrl ($str)
 parseCurUrl ($href, $siteUrl)
 uploadForm ($path)
 createFolder ($path)
 getBulkSelector ($filesCount)

Öffentliche Attribute

 $siteURL
 $thisScript
 $thisConfig
 $setTarget
 $setClass
 $setTitle
 $doc
 $elements = array()
 $mode
 $act
 $expandPage
 $expandFolder
 $P
 $bparams
 $RTEtsConfigParams
 $PM
 $pointer
 $curUrlArray
 $curUrlInfo
 $readOnly = FALSE

Geschützte Attribute

 $hookObjects = array()

Dokumentation der Elementfunktionen

browse_links::barheader ( str  ) 

Prints a 'header' where string is in a tablecell

Parameter:
string The string to print in the header. The value is htmlspecialchars()'ed before output.
Rückgabe:
string The header HTML (wrapped in a table)
browse_links::checkFolder ( folder  ) 

Checks, if a path is within the mountpoints of the backend user

Parameter:
string Absolute filepath
Rückgabe:
boolean If the input path is found in the backend users filemounts, then return true.
browse_links::createFolder ( path  ) 

For TBE: Makes a form for creating new folders in the filemount the user is browsing. The folder creation request is sent to the tce_file.php script in the core which will handle the creation.

Parameter:
string Absolute filepath on server in which to create the new folder.
Rückgabe:
string HTML for the create folder form.
browse_links::expandFolder ( expandFolder = 0,
extensionList = '' 
)

For RTE: This displays all files from folder. No thumbnails shown

Parameter:
string The folder path to expand
string List of fileextensions to show
Rückgabe:
string HTML output
browse_links::expandPage (  ) 

For RTE: This displays all content elements on a page and lets you create a link to the element.

Rückgabe:
string HTML output. Returns content only if the ->expandPage value is set (pointing to a page uid to show tt_content records from ...)
browse_links::fileList ( files,
folderName = '',
noThumbs = 0 
)

Render list of files.

Parameter:
array List of files. See t3lib_div::getFilesInDir
string If set a header with a folder icon and folder name are shown
boolean Whether to show thumbnails or not. If set, no thumbnails are shown.
Rückgabe:
string HTML output
browse_links::folderList ( baseFolder,
folders 
)

Render list of folders.

Parameter:
array List of folders. See t3lib_div::get_dirs
string If set a header with a folder icon and folder name are shown
Rückgabe:
string HTML output
browse_links::getBulkSelector ( filesCount  ) 

Get the HTML data required for a bulk selection of files of the TYPO3 Element Browser.

Parameter:
integer $filesCount: Number of files currently displayed
Rückgabe:
string HTML data required for a bulk selection of files - if $filesCount is 0, nothing is returned
browse_links::getMsgBox ( in_msg,
icon = 'icon_note' 
)

Displays a message box with the input message

Parameter:
string Input message to show (will be htmlspecialchars()'ed inside of this function)
string Icon filename body from gfx/ (default is "icon_note") - meant to allow change to warning type icons...
Rückgabe:
string HTML for the message (wrapped in a table).
browse_links::init (  ) 

Constructor: Initializes a lot of variables, setting JavaScript functions in header etc.

Rückgabe:
void

Splits parts of $this->bparams

Siehe auch:
$bparams

browse_links::isReadOnlyFolder ( folder  ) 

Checks, if a path is within a read-only mountpoint of the backend user

Parameter:
string Absolute filepath
Rückgabe:
boolean If the input path is found in the backend users filemounts and if the filemount is of type readonly, then return true.
browse_links::isWebFolder ( folder  ) 

Verifies that a path is a web-folder:

Parameter:
string Absolute filepath
Rückgabe:
boolean If the input path is found in PATH_site then it returns true.
browse_links::main_db (  ) 

TYPO3 Element Browser: Showing a page tree and allows you to browse for records

Rückgabe:
string HTML content for the module
browse_links::main_file (  ) 

TYPO3 Element Browser: Showing a folder tree, allowing you to browse for files.

Rückgabe:
string HTML content for the module
browse_links::main_folder (  ) 

TYPO3 Element Browser: Showing a folder tree, allowing you to browse for folders.

Rückgabe:
string HTML content for the module
browse_links::main_rte ( wiz = 0  ) 

Rich Text Editor (RTE) link selector (MAIN function) Generates the link selector for the Rich Text Editor. Can also be used to select links for the TCEforms (see $wiz)

Parameter:
boolean If set, the "remove link" is not shown in the menu: Used for the "Select link" wizard which is used by the TCEforms
Rückgabe:
string Modified content variable.
browse_links::parseCurUrl ( href,
siteUrl 
)

For RTE/link: Parses the incoming URL and determines if it's a page, file, external or mail address.

Parameter:
string HREF value tp analyse
string The URL of the current website (frontend)
Rückgabe:
array Array with URL information stored in assoc. keys: value, act (page, file, spec, mail), pageid, cElement, info
browse_links::printCurrentUrl ( str  ) 

For RTE/link: This prints the 'currentUrl'

Parameter:
string URL value. The value is htmlspecialchars()'ed before output.
Rückgabe:
string HTML content, wrapped in a table.
browse_links::processSessionData ( data  ) 

Session data for this class can be set from outside with this method. Call after init()

Parameter:
array Session data array
Rückgabe:
array Session data and boolean which indicates that data needs to be stored in session because it's changed
browse_links::TBE_dragNDrop ( expandFolder = 0,
extensionList = '' 
)

For RTE: This displays all IMAGES (gif,png,jpg) (from extensionList) from folder. Thumbnails are shown for images. This listing is of images located in the web-accessible paths ONLY - the listing is for drag-n-drop use in the RTE

Parameter:
string The folder path to expand
string List of fileextensions to show
Rückgabe:
string HTML output
browse_links::TBE_expandFolder ( expandFolder = 0,
extensionList = '',
noThumbs = 0 
)

For TYPO3 Element Browser: Expand folder of files.

Parameter:
string The folder path to expand
string List of fileextensions to show
boolean Whether to show thumbnails or not. If set, no thumbnails are shown.
Rückgabe:
string HTML output
browse_links::TBE_expandPage ( tables  ) 

For TYPO3 Element Browser: This lists all content elements from the given list of tables

Parameter:
string Commalist of tables. Set to "*" if you want all tables.
Rückgabe:
string HTML output.
browse_links::TBE_expandSubFolders ( expandFolder = 0  ) 

Render list of folders inside a folder.

Parameter:
string string of the current folder
Rückgabe:
string HTML output
browse_links::uploadForm ( path  ) 

For TBE: Makes an upload form for uploading files to the filemount the user is browsing. The files are uploaded to the tce_file.php script in the core which will handle the upload.

Parameter:
string Absolute filepath on server to which to upload.
Rückgabe:
string HTML for an upload form.

Dokumentation der Datenelemente

browse_links::$act

Link selector action. page,file,url,mail,spec are allowed values. These are only important with the link selector function and in that case they switch between the various menu options.

browse_links::$bparams

Active with TYPO3 Element Browser: Contains the name of the form field for which this window opens - thus allows us to make references back to the main window in which the form is. Example value: "data[pages][39][bodytext]|||tt_content|" or "data[tt_content][NEW3fba56fde763d][image]|||gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai|"

Values: 0: form field name reference, eg. "data[tt_content][123][image]" 1: old/unused? 2: old/unused? 3: allowed types. Eg. "tt_content" or "gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai" 4: IRRE uniqueness: target level object-id to perform actions/checks on, eg. "data[79][tt_address][1][<field>][<foreign_table>]" 5: IRRE uniqueness: name of function in opener window that checks if element is already used, eg. "inline.checkUniqueElement" 6: IRRE uniqueness: name of function in opener window that performs some additional(!) action, eg. "inline.setUniqueElement" 7: IRRE uniqueness: name of function in opener window that performs action instead of using addElement/insertElement, eg. "inline.importElement"

$pArr = explode('|',$this->bparams); $formFieldName = $pArr[0]; $allowedTablesOrFileTypes = $pArr[3];

browse_links::$curUrlArray

Used with the link selector: Contains the GET input information about the CURRENT link in the RTE/TCEform field. This consists of "href", "target" and "title" keys. This information is passed around in links.

browse_links::$curUrlInfo

Used with the link selector: Contains a processed version of the input values from curUrlInfo. This is splitted into pageid, content element id, label value etc. This is used for the internal processing of that information.

browse_links::$expandFolder

When you click a folder name/expand icon to see the content of a certain file folder, this value will contain that value (the path of the expanded file folder). If the value is NOT set, then it will be restored from the module session data (see main(), mode="file"/"filedrag"). Example value: "/www/htdocs/typo3/32/3dsplm/fileadmin/css/"

browse_links::$expandPage

When you click a page title/expand icon to see the content of a certain page, this value will contain that value (the ID of the expanded page). If the value is NOT set, then it will be restored from the module session data (see main(), mode="db")

browse_links::$hookObjects = array() [protected]

array which holds hook objects (initialised in init() )

browse_links::$mode

The mode determines the main kind of output from the element browser. There are these options for values: rte, db, file, filedrag, wizard. "rte" will show the link selector for the Rich Text Editor (see main_rte()) "db" will allow you to browse for pages or records in the page tree (for TCEforms, see main_db()) "file"/"filedrag" will allow you to browse for files or folders in the folder mounts (for TCEforms, main_file()) "wizard" will allow you to browse for links (like "rte") which are passed back to TCEforms (see main_rte(1))

Siehe auch:
main()
browse_links::$P

TYPO3 Element Browser, wizard mode parameters. There is a heap of parameters there, better debug() them out if you need something... :-)

browse_links::$PM

Plus/Minus icon value. Used by the tree class to open/close notes on the trees.

browse_links::$pointer

Pointer, used when browsing a long list of records etc.

browse_links::$RTEtsConfigParams

Used with the Rich Text Editor. Example value: "tt_content:NEW3fba58c969f5c:bodytext:23:text:23:"


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