Cleanup: Added public static definitions to TSpagegen
[Packages/TYPO3.CMS.git] / typo3 / alt_file_navframe.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (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 tree in the File main module.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 72: class localFolderTree extends t3lib_folderTree
42 * 81: function localFolderTree()
43 * 92: function wrapIcon($icon,&$row)
44 * 121: function wrapTitle($title,$row,$bank=0)
45 *
46 *
47 * 146: class SC_alt_file_navframe
48 * 163: function init()
49 * 253: function main()
50 * 284: function printContent()
51 *
52 * TOTAL FUNCTIONS: 6
53 * (This index is automatically created/updated by the extension "extdeveval")
54 *
55 */
56
57 $BACK_PATH = '';
58 require_once('init.php');
59 require('template.php');
60 require_once('class.filelistfoldertree.php');
61
62
63 /**
64 * Main script class for rendering of the folder tree
65 *
66 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
67 * @package TYPO3
68 * @subpackage core
69 */
70 class SC_alt_file_navframe {
71
72 // Internal, dynamic:
73 var $content; // Content accumulates in this variable.
74 var $foldertree; // Folder tree object.
75
76 /**
77 * document template object
78 *
79 * @var template
80 */
81 var $doc;
82 var $backPath;
83
84 // Internal, static: GPvar:
85 var $currentSubScript;
86 var $cMR;
87
88
89 /**
90 * Initialiation of the script class
91 *
92 * @return void
93 */
94 function init() {
95 global $BE_USER, $BACK_PATH;
96
97 // Setting backPath
98 $this->backPath = $BACK_PATH;
99
100 // Setting GPvars:
101 $this->currentSubScript = t3lib_div::_GP('currentSubScript');
102 $this->cMR = t3lib_div::_GP('cMR');
103
104 // Create folder tree object:
105 $this->foldertree = t3lib_div::makeInstance('filelistFolderTree');
106 $this->foldertree->ext_IconMode = $BE_USER->getTSConfigVal('options.folderTree.disableIconLinkToContextmenu');
107 $this->foldertree->thisScript = 'alt_file_navframe.php';
108 }
109
110
111 /**
112 * initialization for the visual parts of the class
113 * Use template rendering only if this is a non-AJAX call
114 *
115 * @return void
116 */
117 public function initPage() {
118 global $BE_USER, $BACK_PATH, $CLIENT;
119
120 // Setting highlight mode:
121 $this->doHighlight = !$BE_USER->getTSConfigVal('options.pageTree.disableTitleHighlight');
122
123 // Create template object:
124 $this->doc = t3lib_div::makeInstance('template');
125 $this->doc->backPath = $BACK_PATH;
126 $this->doc->setModuleTemplate('templates/alt_file_navframe.html');
127
128 // Adding javascript code for AJAX (prototype), drag&drop and the filetree as well as the click menu code
129 $this->doc->getDragDropCode('folders');
130 $this->doc->getContextMenuCode();
131
132 // Setting JavaScript for menu.
133 $this->doc->JScode .= $this->doc->wrapScriptTags(
134
135 ($this->currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($this->currentSubScript).'");':'').'
136
137 // setting prefs for foldertree
138 Tree.ajaxID = "SC_alt_file_navframe::expandCollapse";
139
140 // Function, loading the list frame from navigation tree:
141 function jumpTo(id, linkObj, highlightID, bank) {
142 var theUrl = top.TS.PATH_typo3 + top.currentSubScript ;
143 if (theUrl.indexOf("?") != -1) {
144 theUrl += "&id=" + id
145 } else {
146 theUrl += "?id=" + id
147 }
148 top.fsMod.currentBank = bank;
149
150 if (top.condensedMode) {
151 top.content.location.href = theUrl;
152 } else {
153 parent.list_frame.location.href=theUrl;
154 }
155
156 '.($this->doHighlight ? 'Tree.highlightActiveItem("file", highlightID + "_" + bank);' : '').'
157 '.(!$CLIENT['FORMSTYLE'] ? '' : 'if (linkObj) linkObj.blur(); ').'
158 return false;
159 }
160 '.($this->cMR ? " jumpTo(top.fsMod.recentIds['file'],'');" : '')
161 );
162 }
163
164
165 /**
166 * Main function, rendering the folder tree
167 *
168 * @return void
169 */
170 function main() {
171 global $LANG,$CLIENT;
172
173 // Produce browse-tree:
174 $tree = $this->foldertree->getBrowsableTree();
175
176 // Outputting page tree:
177 $this->content.= $tree;
178
179 // Adding javascript for drag & drop activation and highlighting
180 $this->content .=$this->doc->wrapScriptTags('
181 '.($this->doHighlight ? 'Tree.highlightActiveItem("", top.fsMod.navFrameHighlightedID["file"]);' : '').'
182 '.(!$this->doc->isCMlayers() ? 'Tree.activateDragDrop = false;' : 'Tree.registerDragDropHandlers();')
183 );
184
185 // Setting up the buttons and markers for docheader
186 $docHeaderButtons = $this->getButtons();
187 $markers = array(
188 'IMG_RESET' => '<img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/close_gray.gif', ' width="16" height="16"') . ' id="treeFilterReset" alt="Reset Filter" />',
189 'CONTENT' => $this->content
190 );
191
192 $subparts = array();
193
194 // Possible filter/search like in page tree
195 $subparts['###SECOND_ROW###'] = '';
196
197 // Build the <body> for the module
198 $this->content = $this->doc->startPage('TYPO3 Folder Tree');
199 $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers, $subparts);
200 $this->content.= $this->doc->endPage();
201 $this->content = $this->doc->insertStylesAndJS($this->content);
202 }
203
204 /**
205 * Outputting the accumulated content to screen
206 *
207 * @return void
208 */
209 function printContent() {
210 echo $this->content;
211 }
212
213 /**
214 * Create the panel of buttons for submitting the form or otherwise perform operations.
215 *
216 * @return array all available buttons as an assoc. array
217 */
218 protected function getButtons() {
219 $buttons = array(
220 'csh' => '',
221 'refresh' => '',
222 );
223
224 // Refresh
225 $buttons['refresh'] = '<a href="' . htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')) . '">' .
226 '<img' . t3lib_iconWorks::skinImg('','gfx/refresh_n.gif','width="14" height="14"') . ' title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1) . '" alt="" /></a>';
227
228 // CSH
229 $buttons['csh'] = str_replace('typo3-csh-inline','typo3-csh-inline show-right',t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'filetree', $GLOBALS['BACK_PATH']));
230
231 return $buttons;
232 }
233
234 /**********************************
235 *
236 * AJAX Calls
237 *
238 **********************************/
239
240 /**
241 * Makes the AJAX call to expand or collapse the foldertree.
242 * Called by typo3/ajax.php
243 *
244 * @param array $params: additional parameters (not used here)
245 * @param TYPO3AJAX &$ajaxObj: reference of the TYPO3AJAX object of this request
246 * @return void
247 */
248 public function ajaxExpandCollapse($params, &$ajaxObj) {
249 global $LANG;
250
251 $this->init();
252 $tree = $this->foldertree->getBrowsableTree();
253 if (!$this->foldertree->ajaxStatus) {
254 $ajaxObj->setError($tree);
255 } else {
256 $ajaxObj->addContent('tree', $tree);
257 }
258 }
259 }
260
261
262 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_file_navframe.php']) {
263 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_file_navframe.php']);
264 }
265
266
267 // Make instance if it is not an AJAX call
268 if (!(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX)) {
269 $SOBE = t3lib_div::makeInstance('SC_alt_file_navframe');
270 $SOBE->init();
271 $SOBE->initPage();
272 $SOBE->main();
273 $SOBE->printContent();
274 }
275
276 ?>