"TYPO3 4.0.1: fileList Class Reference", "datetime" => "Sat Dec 2 19:24:56 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

fileList Class Reference

Inheritance diagram for fileList:

[legend]Collaboration diagram for fileList:

[legend]List of all members.

Public Member Functions
	start ($path, $pointer, $sort, $sortRev, $clipBoard=0)
	generateList ()
	writeTop ($path)
	linkClipboardHeaderIcon ($string, $table, $cmd, $warning='')
	getTable ($files, $dirs, $rowlist)
	formatDirList ($items)
	linkWrapDir ($code, $path)
	linkWrapFile ($code, $path)
	listURL ()
	dirData ($theFile)
	formatFileList ($items)
	isImage ($ext)
	linkWrapSort ($code, $path, $col)
	readDirectory ($path, $type, $extList='')
	makeClip ($theData)
	makeRef ($theData)
Public Attributes
	$iLimit = 40
	$thumbs = 0
	$widthGif = '<img src="clear.gif" width="1" height="1" hspace="165" alt="" />'
	$fixedL = 30
	$script = 'file_list.php'
	$clickMenus = 1
	$sort = ''
	$sortRev = 1
	$firstElementNumber = 0
	$clipBoard = 0
	$JScode = ''
	$HTMLcode = ''
	$totalbytes = 0
	$dirs = Array()
	$files = Array()
	$path = ''
	$eCounter = 0
	$totalItems = ''
	$CBnames = array()

---

Detailed Description

Definition at line 75 of file class.file_list.inc.

---

Member Function Documentation

fileList::dirData (  $  theFile  )

Returns some data specific for the directories... Parameters: array  File information array Returns: array (title, icon, path) Definition at line 416 of file class.file_list.inc. References $path, and t3lib_BEfunc::getPathType_web_nonweb(). Referenced by formatDirList(), and writeTop().

fileList::formatDirList (  $  items  )

This returns tablerows for the directories in the array $items['sorting']. Parameters: array  Directory items Returns: string HTML table rows. Definition at line 306 of file class.file_list.inc. References $path, dirData(), t3lib_div::fixed_lgd(), t3lib_recordList::fwd_rwd_nav(), linkWrapDir(), makeClip(), and makeRef(). Referenced by getTable().

fileList::formatFileList (  $  items  )

This returns tablerows for the files in the array $items['sorting']. Parameters: array  File items Returns: string HTML table rows. Definition at line 441 of file class.file_list.inc. References t3lib_div::fixed_lgd(), t3lib_div::formatSize(), t3lib_recordList::fwd_rwd_nav(), t3lib_BEfunc::getFileIcon(), isImage(), linkWrapFile(), makeClip(), and makeRef(). Referenced by getTable().

fileList::generateList (   )

Reading files and directories, counting elements and generating the list in ->HTMLcode Returns: void Definition at line 133 of file class.file_list.inc. References getTable(), and readDirectory().

fileList::getTable (  $  files, $  dirs, $  rowlist )

Returns a table with directories and files listed. Parameters: array  Array of files from path array  Array of directories from path string  List of rows to display horizontallyh Returns: string HTML-table Definition at line 218 of file class.file_list.inc. References $dirs, $files, formatDirList(), formatFileList(), linkClipboardHeaderIcon(), linkWrapSort(), t3lib_div::rmFromList(), t3lib_iconWorks::skinImg(), and t3lib_div::uniqueList(). Referenced by generateList().

fileList::isImage (  $  ext  )

Returns true if $ext is an image-extension according to $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] Parameters: string  file extension Returns: boolean Definition at line 518 of file class.file_list.inc. References t3lib_div::inList(). Referenced by formatFileList().

fileList::linkClipboardHeaderIcon (  $  string, $  table, $  cmd, $  warning = '' )

Wrapping input string in a link with clipboard command. Parameters: string  String to be linked - must be htmlspecialchar'ed / prepared before. string  table - NOT USED string  "cmd" value string  Warning for JS confirm message Returns: string Linked string Definition at line 204 of file class.file_list.inc. Referenced by getTable().

fileList::linkWrapDir (  $  code, $  path )

Wraps the directory-titles Parameters: string  String to be wrapped in links string  ID (path) Returns: string HTML Definition at line 372 of file class.file_list.inc. References $path. Referenced by formatDirList(), and writeTop().

fileList::linkWrapFile (  $  code, $  path )

Wraps filenames in links which opens them in a window IF they are in web-path. Parameters: string  String to be wrapped in links string  ID (path) Returns: string HTML Definition at line 391 of file class.file_list.inc. References $path, t3lib_div::getIndpEnv(), and t3lib_div::isFirstPartOfStr(). Referenced by formatFileList().

fileList::linkWrapSort (  $  code, $  path, $  col )

Wraps the directory-titles ($code) in a link to file_list.php (id=$path) and sorting commands... Parameters: string  String to be wrapped string  ID (path) string  Sorting column Returns: string HTML Definition at line 530 of file class.file_list.inc. References $path. Referenced by getTable().

fileList::listURL (   )

Returns list URL; This is the URL of the current script with id and imagemode parameters, thats all. Returns: string URL Definition at line 406 of file class.file_list.inc.

fileList::makeClip (  $  theData  )

Creates the clipboard control pad Parameters: array  Array with information about the file/directory for which to make the clipboard panel for the listing. Returns: string HTML-table Definition at line 602 of file class.file_list.inc. Referenced by formatDirList(), and formatFileList().

fileList::makeRef (  $  theData  )

Make reference count Parameters: array  Array with information about the file/directory for which to make the clipboard panel for the listing. Returns: string HTML Definition at line 647 of file class.file_list.inc. References t3lib_div::isFirstPartOfStr(). Referenced by formatDirList(), and formatFileList().

fileList::readDirectory (  $  path, $  type, $  extList = '' )

Returns an array with file/dir items + an array with the sorted items Parameters: string  Path (absolute) to read string  $type is the technical type; file,dir,link. empty is all kinds of stuff. string  $extList: List of fileextensions to select. If empty, all are selected. Returns: array Array('files'=>array(), 'sorting'=>array()); Definition at line 548 of file class.file_list.inc. References $path, t3lib_div::inList(), and t3lib_div::split_fileref(). Referenced by generateList().

fileList::start (  $  path, $  pointer, $  sort, $  sortRev, $  clipBoard = 0 )

Initialization of class Parameters: string  The path to list integer  Pointer boolean  Sorting column boolean  Sorting direction boolean  Show clipboard flag Returns: void Definition at line 112 of file class.file_list.inc. References $clipBoard, $path, $sort, and $sortRev.

fileList::writeTop (  $  path  )

Make the top of the list Parameters: string  The path to list. Returns: void Definition at line 146 of file class.file_list.inc. References $path, dirData(), t3lib_div::fixed_lgd_cs(), linkWrapDir(), and t3lib_iconWorks::skinImg().

---

The documentation for this class was generated from the following file:

• typo3_src-4.0.1/typo3/class.file_list.inc