t3lib_folderTree Class Reference

Inheritance diagram for t3lib_folderTree:

Collaboration diagram for t3lib_folderTree:

List of all members.

Public Member Functions
	t3lib_folderTree ()
	wrapIcon ($icon, $row)
	wrapTitle ($title, $row, $bank=0)
	getId ($v)
	getJumpToParam ($v)
	getTitleStr ($row, $titleLen=30)
	getBrowsableTree ()
	getFolderTree ($files_path, $depth=999, $depthData= '', $type= '')
	getCount ($files_path)
	initializePositionSaving ()

---

Detailed Description

Definition at line 68 of file class.t3lib_foldertree.php.

---

Member Function Documentation

t3lib_folderTree::getBrowsableTree

(

)

Will create and return the HTML code for a browsable tree of folders. Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)

Returns:

string HTML code for the browsable tree

Reimplemented from t3lib_treeView.

Reimplemented in filelistFolderTree.

Definition at line 163 of file class.t3lib_foldertree.php.

t3lib_folderTree::getCount

(

$

files_path

)

Counts the number of directories in a file path.

Parameters:

string

File path.

Returns:

integer

Reimplemented from t3lib_treeView.

Definition at line 316 of file class.t3lib_foldertree.php.

References t3lib_div\get_dirs().

t3lib_folderTree::getFolderTree	(	$	files_path,
		$	depth = 999,
		$	depthData = '',
		$	type = ''
	)

Fetches the data for the tree

Parameters:

string	Abs file path
integer	Max depth (recursivity limit)
string	HTML-code prefix for recursive calls.

Returns:

integer The count of items on the level

See also:

getBrowsableTree()

Definition at line 235 of file class.t3lib_foldertree.php.

t3lib_folderTree::getId

(

$

v

)

Returns the id from the record - for folders, this is an md5 hash.

Parameters:

array

Record array

Returns:

integer The "uid" field value.

Reimplemented from t3lib_treeView.

Definition at line 131 of file class.t3lib_foldertree.php.

Referenced by wrapIcon().

t3lib_folderTree::getJumpToParam

(

$

v

)

Returns jump-url parameter value.

Parameters:

array

The record array.

Returns:

string The jump-url parameter.

Reimplemented from t3lib_treeView.

Definition at line 141 of file class.t3lib_foldertree.php.

Referenced by wrapIcon().

t3lib_folderTree::getTitleStr	(	$	row,
		$	titleLen = 30
	)

Returns the title for the input record. If blank, a "no title" labele (localized) will be returned. '_title' is used for setting an alternative title for folders.

Parameters:

array	The input row array (where the key "_title" is used for the title)
integer	Title length (30)

Returns:

string The title.

Reimplemented from t3lib_treeView.

Definition at line 153 of file class.t3lib_foldertree.php.

t3lib_folderTree::initializePositionSaving

(

)

Get stored tree structure AND updating it if needed according to incoming PM GET var.

Returns:

void private

Reimplemented from t3lib_treeView.

Reimplemented in localFolderTree.

Definition at line 332 of file class.t3lib_foldertree.php.

References t3lib_div\_GP().

t3lib_folderTree::t3lib_folderTree

(

)

Constructor function of the class

Returns:

void

Definition at line 75 of file class.t3lib_foldertree.php.

References $GLOBALS, and t3lib_treeView\init().

Referenced by filelistFolderTree\filelistFolderTree().

t3lib_folderTree::wrapIcon	(	$	icon,
		$	row
	)

Wrapping the folder icon

Parameters:

string	The image tag for the icon
array	The row for the current element

Returns:

string The processed icon input value. private

Reimplemented from t3lib_treeView.

Reimplemented in localFolderTree.

Definition at line 93 of file class.t3lib_foldertree.php.

References $GLOBALS, $row, t3lib_treeView\addTagAttributes(), getId(), getJumpToParam(), and t3lib_treeView\getTitleAttrib().

t3lib_folderTree::wrapTitle	(	$	title,
		$	row,
		$	bank = 0
	)

Wrapping $title in a-tags.

Parameters:

string	Title string
string	Item record
integer	Bank pointer (which mount point number)

Returns:

string private

Reimplemented from t3lib_treeView.

Reimplemented in filelistFolderTree.

Definition at line 116 of file class.t3lib_foldertree.php.

---

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

• t3lib/class.t3lib_foldertree.php