[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / class.filelistfoldertree.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Folder navigation tree for the File main module
29 *
30 * @author Benjamin Mack <bmack@xnos.org>
31 *
32 *
33 * [CLASS/FUNCTION INDEX of SCRIPT]
34 *
35 * 71: class fileListTree extends t3lib_browseTree
36 * 81: function webPageTree()
37 * 92: function wrapIcon($icon, &$row)
38 * 130: function wrapStop($str, $row)
39 * 146: function wrapTitle($title, $row, $bank=0)
40 * 165: function printTree($treeItems = '')
41 * 271: function PMicon($row, $a, $c, $nextCount, $exp)
42 * 292: function PMiconATagWrap($icon, $cmd, $isExpand = TRUE)
43 * 309: function getBrowsableTree()
44 * 377: function getTree($uid, $depth=999, $depthData='', $blankLineCode='', $subCSSclass='')
45 *
46 *
47 * TOTAL FUNCTIONS: 9
48 * (This index is automatically created/updated by the extension "extdeveval")
49 *
50 */
51 /**
52 * Extension class for the t3lib_filetree class, needed for drag and drop and ajax functionality
53 *
54 * @author Sebastian Kurfürst <sebastian@garbage-group.de>
55 * @author Benjamin Mack <bmack@xnos.org>
56 * @package TYPO3
57 * @subpackage core
58 * @see class t3lib_browseTree
59 */
60 class filelistFolderTree extends t3lib_folderTree {
61
62 var $ext_IconMode;
63
64 /**
65 * Wrapping icon in browse tree
66 *
67 * @param string $theFolderIcon Icon IMG code
68 * @param t3lib_file_Folder $folderObject the folder object
69 * @return string folder icon
70 */
71 function wrapIcon($theFolderIcon, t3lib_file_Folder $folderObject) {
72 $theFolderIcon = parent::wrapIcon($theFolderIcon, $folderObject);
73 // Wrap icon in a drag/drop span.
74 return '<span class="dragIcon" id="dragIconID_' . $this->getJumpToParam($folderObject) . '">' . $theFolderIcon . '</span>';
75 }
76
77 /**
78 * Wrapping $title in a-tags.
79 *
80 * @param string $title Title string
81 * @param t3lib_file_Folder $folderObject Folder to work on
82 * @param integer $bank Bank pointer (which mount point number)
83 * @return string
84 * @access private
85 */
86 function wrapTitle($title, t3lib_file_Folder $folderObject, $bank = 0) {
87 $theFolderTitle = parent::wrapTitle($title, $folderObject, $bank);
88
89 // Wrap title in a drag/drop span.
90 return '<span class="dragTitle" id="dragTitleID_' . $this->getJumpToParam($folderObject) . '">' . $theFolderTitle . '</span>';
91 }
92 }
93 ?>