[TASK] CGL: Improve function spacing
[Packages/TYPO3.CMS.git] / typo3 / class.webpagetree.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 * Page navigation tree for the Web module
29 *
30 * Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
31 * XHTML compliant
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 * @author Benjamin Mack <bmack@xnos.org>
35 *
36 *
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 71: class webPageTree extends t3lib_browseTree
42 * 81: function webPageTree()
43 * 92: function wrapIcon($icon, &$row)
44 * 130: function wrapStop($str, $row)
45 * 146: function wrapTitle($title, $row, $bank=0)
46 * 165: function printTree($treeArr = '')
47 * 271: function PMicon($row, $a, $c, $nextCount, $exp)
48 * 292: function PMiconATagWrap($icon, $cmd, $isExpand = TRUE)
49 * 309: function getBrowsableTree()
50 * 377: function getTree($uid, $depth=999, $depthData='', $blankLineCode='', $subCSSclass='')
51 *
52 *
53 * TOTAL FUNCTIONS: 9
54 * (This index is automatically created/updated by the extension "extdeveval")
55 *
56 */
57
58
59 /**
60 * Extension class for the t3lib_browsetree class, specially made
61 * for browsing pages in the Web module
62 *
63 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
64 * @author Benjamin Mack <bmack@xnos.org>
65 * @package TYPO3
66 * @subpackage core
67 * @see class t3lib_browseTree
68 */
69 class webPageTree extends t3lib_browseTree {
70
71 var $ext_showPageId;
72 var $ext_IconMode;
73 var $ext_separateNotinmenuPages;
74 var $ext_alphasortNotinmenuPages;
75 var $ajaxStatus = FALSE; // Indicates, whether the ajax call was successful, i.e. the requested page has been found
76
77 /**
78 * Calls init functions
79 *
80 * @return void
81 */
82 function __construct() {
83 $this->init();
84 }
85
86 /**
87 * Wrapping icon in browse tree
88 *
89 * @param string Icon IMG code
90 * @param array Data row for element.
91 * @return string Page icon
92 */
93 function wrapIcon($thePageIcon, &$row) {
94 // If the record is locked, present a warning sign.
95 if ($lockInfo=t3lib_BEfunc::isRecordLocked('pages', $row['uid'])) {
96 $aOnClick = 'alert('.$GLOBALS['LANG']->JScharCode($lockInfo['msg']).');return false;';
97 $lockIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.
98 t3lib_iconWorks::getSpriteIcon('status-warning-in-use', array('title'=>htmlspecialchars($lockInfo['msg']))).
99 '</a>';
100 } else $lockIcon = '';
101
102 // Wrap icon in click-menu link.
103 if (!$this->ext_IconMode) {
104 $thePageIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($thePageIcon, 'pages', $row['uid'], 0, '&bank='.$this->bank);
105 } elseif (!strcmp($this->ext_IconMode, 'titlelink')) {
106 $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->treeName.'\');';
107 $thePageIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$thePageIcon.'</a>';
108 }
109
110 // Wrap icon in a drag/drop span.
111 $dragDropIcon = '<span class="dragIcon" id="dragIconID_'.$row['uid'].'">'.$thePageIcon.'</span>';
112
113 // Add Page ID:
114 $pageIdStr = '';
115 if ($this->ext_showPageId) {
116 $pageIdStr = '<span class="dragId">[' . $row['uid'] . ']</span> ';
117 }
118
119 // Call stats information hook
120 $stat = '';
121 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'])) {
122 $_params = array('pages', $row['uid']);
123 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'] as $_funcRef) {
124 $stat.=t3lib_div::callUserFunction($_funcRef, $_params, $this);
125 }
126 }
127
128 return $dragDropIcon.$lockIcon.$pageIdStr.$stat;
129 }
130
131 /**
132 * Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
133 *
134 * @param string Input string, like a page title for the tree
135 * @param array record row with "php_tree_stop" field
136 * @return string Modified string
137 * @access private
138 */
139 function wrapStop($str, $row) {
140 if ($row['php_tree_stop']) {
141 $str.='<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => $row['uid']))).'" class="typo3-red">+</a> ';
142 }
143 return $str;
144 }
145
146 /**
147 * Wrapping $title in a-tags.
148 *
149 * @param string Title string
150 * @param string Item record
151 * @param integer Bank pointer (which mount point number)
152 * @return string
153 * @access private
154 */
155 function wrapTitle($title, $row, $bank=0) {
156 // Hook for overriding the page title
157 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'])) {
158 $_params = array('title' => &$title, 'row' => &$row);
159 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'] as $_funcRef) {
160 t3lib_div::callUserFunction($_funcRef, $_params, $this);
161 }
162 unset($_params);
163 }
164
165 $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->domIdPrefix.$this->getId($row).'\','.$bank.');';
166 $CSM = ' oncontextmenu="'.htmlspecialchars($GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon('', 'pages', $row['uid'], 0, '&bank='.$this->bank, '', TRUE)).';"';
167 $thePageTitle='<a href="#" onclick="'.htmlspecialchars($aOnClick).'"'.$CSM.'>'.$title.'</a>';
168
169 // Wrap title in a drag/drop span.
170 return '<span class="dragTitle" id="dragTitleID_'.$row['uid'].'">'.$thePageTitle.'</span>';
171 }
172
173
174 /**
175 * Compiles the HTML code for displaying the structure found inside the ->tree array
176 *
177 * @param array "tree-array" - if blank string, the internal ->tree array is used.
178 * @return string The HTML code for the tree
179 */
180 function printTree($treeArr = '') {
181 $titleLen = intval($this->BE_USER->uc['titleLen']);
182 if (!is_array($treeArr)) {
183 $treeArr = $this->tree;
184 }
185
186 $out = '
187 <!-- TYPO3 tree structure. -->
188 <ul class="tree" id="treeRoot">
189 ';
190
191 // -- evaluate AJAX request
192 // IE takes anchor as parameter
193 $PM = t3lib_div::_GP('PM');
194 if(($PMpos = strpos($PM, '#')) !== FALSE) { $PM = substr($PM, 0, $PMpos); }
195 $PM = explode('_', $PM);
196 if ((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) && is_array($PM) && count($PM) == 4 && $PM[2] != 0) {
197 if($PM[1]) {
198 $expandedPageUid = $PM[2];
199 $ajaxOutput = '';
200 $invertedDepthOfAjaxRequestedItem = 0; // We don't know yet. Will be set later.
201 $doExpand = TRUE;
202 } else {
203 $collapsedPageUid = $PM[2];
204 $doCollapse = TRUE;
205 }
206 }
207
208 // we need to count the opened <ul>'s every time we dig into another level,
209 // so we know how many we have to close when all children are done rendering
210 $closeDepth = array();
211
212 foreach($treeArr as $k => $v) {
213 $classAttr = $v['row']['_CSSCLASS'];
214 $uid = $v['row']['uid'];
215 $idAttr = htmlspecialchars($this->domIdPrefix.$this->getId($v['row']).'_'.$v['bank']);
216 $itemHTML = '';
217
218 // if this item is the start of a new level,
219 // then a new level <ul> is needed, but not in ajax mode
220 if($v['isFirst'] && !($doCollapse) && !($doExpand && $expandedPageUid == $uid)) {
221 $itemHTML = '<ul>';
222 }
223
224 // add CSS classes to the list item
225 if($v['hasSub']) { $classAttr .= ($classAttr) ? ' expanded': 'expanded'; }
226 if($v['isLast']) { $classAttr .= ($classAttr) ? ' last' : 'last'; }
227
228 $itemHTML .='
229 <li id="'.$idAttr.'"'.($classAttr ? ' class="'.$classAttr.'"' : '').'><div class="treeLinkItem">'.
230 $v['HTML'].
231 $this->wrapTitle($this->getTitleStr($v['row'], $titleLen), $v['row'], $v['bank'])."</div>\n";
232
233
234 if(!$v['hasSub']) { $itemHTML .= '</li>'; }
235
236 // we have to remember if this is the last one
237 // on level X so the last child on level X+1 closes the <ul>-tag
238 if($v['isLast'] && !($doExpand && $expandedPageUid == $uid)) { $closeDepth[$v['invertedDepth']] = 1; }
239
240
241 // if this is the last one and does not have subitems, we need to close
242 // the tree as long as the upper levels have last items too
243 if($v['isLast'] && !$v['hasSub'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) {
244 for ($i = $v['invertedDepth']; $closeDepth[$i] == 1; $i++) {
245 $closeDepth[$i] = 0;
246 $itemHTML .= '</ul></li>';
247 }
248 }
249
250 // ajax request: collapse
251 if($doCollapse && $collapsedPageUid == $uid) {
252 $this->ajaxStatus = TRUE;
253 return $itemHTML;
254 }
255
256 // ajax request: expand
257 if($doExpand && $expandedPageUid == $uid) {
258 $ajaxOutput .= $itemHTML;
259 $invertedDepthOfAjaxRequestedItem = $v['invertedDepth'];
260 } elseif($invertedDepthOfAjaxRequestedItem) {
261 if($v['invertedDepth'] < $invertedDepthOfAjaxRequestedItem) {
262 $ajaxOutput .= $itemHTML;
263 } else {
264 $this->ajaxStatus = TRUE;
265 return $ajaxOutput;
266 }
267 }
268
269 $out .= $itemHTML;
270 }
271
272 if($ajaxOutput) {
273 $this->ajaxStatus = TRUE;
274 return $ajaxOutput;
275 }
276
277 // finally close the first ul
278 $out .= '</ul>';
279 return $out;
280 }
281
282
283 /**
284 * Generate the plus/minus icon for the browsable tree.
285 *
286 * @param array record for the entry
287 * @param integer The current entry number
288 * @param integer The total number of entries. If equal to $a, a "bottom" element is returned.
289 * @param integer The number of sub-elements to the current element.
290 * @param boolean The element was expanded to render subelements if this flag is set.
291 * @return string Image tag with the plus/minus icon.
292 * @access private
293 * @see t3lib_pageTree::PMicon()
294 */
295 function PMicon($row, $a, $c, $nextCount, $exp) {
296 $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join';
297 $BTM = ($a == $c) ? 'bottom' : '';
298 $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath, 'gfx/ol/'.$PM.$BTM.'.gif', 'width="18" height="16"').' alt="" />';
299
300 if ($nextCount) {
301 $cmd = $this->bank.'_'.($exp?'0_':'1_').$row['uid'].'_'.$this->treeName;
302 $icon = $this->PMiconATagWrap($icon, $cmd, !$exp);
303 }
304 return $icon;
305 }
306
307
308 /**
309 * Wrap the plus/minus icon in a link
310 *
311 * @param string HTML string to wrap, probably an image tag.
312 * @param string Command for 'PM' get var
313 * @return string Link-wrapped input string
314 * @access private
315 */
316 function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) {
317 if ($this->thisScript) {
318 // activate dynamic ajax-based tree
319 $js = htmlspecialchars('Tree.load(\''.$cmd.'\', '.intval($isExpand).', this);');
320 return '<a class="pm" onclick="'.$js.'">'.$icon.'</a>';
321 } else {
322 return $icon;
323 }
324 }
325
326
327 /**
328 * Will create and return the HTML code for a browsable tree
329 * Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)
330 *
331 * @return string HTML code for the browsable tree
332 */
333 function getBrowsableTree() {
334
335 // Get stored tree structure AND updating it if needed according to incoming PM GET var.
336 $this->initializePositionSaving();
337
338 // Init done:
339 $titleLen = intval($this->BE_USER->uc['titleLen']);
340 $treeArr = array();
341
342 // Traverse mounts:
343 foreach($this->MOUNTS as $idx => $uid) {
344
345 // Set first:
346 $this->bank = $idx;
347 $isOpen = $this->stored[$idx][$uid] || $this->expandFirst || $uid === '0';
348
349 // Save ids while resetting everything else.
350 $curIds = $this->ids;
351 $this->reset();
352 $this->ids = $curIds;
353
354 // Set PM icon for root of mount:
355 $cmd = $this->bank.'_'.($isOpen? "0_" : "1_").$uid.'_'.$this->treeName;
356 // only, if not for uid 0
357 if ($uid) {
358 $icon = '<img' . t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/' . ($isOpen ? 'minus' :'plus' ) . 'only.gif') . ' alt="" />';
359 $firstHtml = $this->PMiconATagWrap($icon, $cmd, !$isOpen);
360 }
361
362 // Preparing rootRec for the mount
363 if ($uid) {
364 $rootRec = $this->getRecord($uid);
365 $firstHtml.=$this->getIcon($rootRec);
366 } else {
367 // Artificial record for the tree root, id=0
368 $rootRec = $this->getRootRecord($uid);
369 $firstHtml.=$this->getRootIcon($rootRec);
370 }
371
372 if (is_array($rootRec)) {
373 // In case it was swapped inside getRecord due to workspaces.
374 $uid = $rootRec['uid'];
375
376 // Add the root of the mount to ->tree
377 $this->tree[] = array('HTML'=>$firstHtml, 'row'=>$rootRec, 'bank'=>$this->bank, 'hasSub'=>TRUE, 'invertedDepth'=>1000);
378
379 // If the mount is expanded, go down:
380 if ($isOpen) {
381 // Set depth:
382 if ($this->addSelfId) { $this->ids[] = $uid; }
383 $this->getTree($uid, 999, '', $rootRec['_SUBCSSCLASS']);
384 }
385 // Add tree:
386 $treeArr=array_merge($treeArr, $this->tree);
387 }
388 }
389 return $this->printTree($treeArr);
390 }
391
392
393 /**
394 * Fetches the data for the tree
395 *
396 * @param integer item id for which to select subitems (parent id)
397 * @param integer Max depth (recursivity limit)
398 * @param string ? (internal)
399 * @return integer The count of items on the level
400 */
401 function getTree($uid, $depth=999, $blankLineCode='', $subCSSclass='') {
402
403 // Buffer for id hierarchy is reset:
404 $this->buffer_idH = array();
405
406 // Init vars
407 $depth = intval($depth);
408 $HTML = '';
409 $a = 0;
410
411 $res = $this->getDataInit($uid, $subCSSclass);
412 $c = $this->getDataCount($res);
413 $crazyRecursionLimiter = 999;
414
415 $inMenuPages = array();
416 $outOfMenuPages = array();
417 $outOfMenuPagesTextIndex = array();
418 while ($crazyRecursionLimiter > 0 && $row = $this->getDataNext($res, $subCSSclass)) {
419 $crazyRecursionLimiter--;
420
421 // Not in menu:
422 if ($this->ext_separateNotinmenuPages &&
423 ($row['doktype'] == t3lib_pageSelect::DOKTYPE_BE_USER_SECTION ||
424 $row['doktype'] >= 200 || $row['nav_hide'])) {
425 $outOfMenuPages[] = $row;
426 $outOfMenuPagesTextIndex[] = ($row['doktype']>=200 ? 'zzz'.$row['doktype'].'_' : '').$row['title'];
427 } else {
428 $inMenuPages[] = $row;
429 }
430 }
431
432 $label_shownAlphabetically = "";
433 if (count($outOfMenuPages)) {
434 // Sort out-of-menu pages:
435 $outOfMenuPages_alphabetic = array();
436 if ($this->ext_alphasortNotinmenuPages) {
437 asort($outOfMenuPagesTextIndex);
438 $label_shownAlphabetically = " (alphabetic)";
439 }
440 foreach($outOfMenuPagesTextIndex as $idx => $txt) {
441 $outOfMenuPages_alphabetic[] = $outOfMenuPages[$idx];
442 }
443
444 // Merge:
445 $outOfMenuPages_alphabetic[0]['_FIRST_NOT_IN_MENU']=TRUE;
446 $allRows = array_merge($inMenuPages, $outOfMenuPages_alphabetic);
447 } else {
448 $allRows = $inMenuPages;
449 }
450
451 // Traverse the records:
452 foreach ($allRows as $row) {
453 $a++;
454
455 $newID = $row['uid'];
456 $this->tree[]=array(); // Reserve space.
457 end($this->tree);
458 $treeKey = key($this->tree); // Get the key for this space
459 $LN = ($a==$c) ? 'blank' : 'line';
460
461 // If records should be accumulated, do so
462 if ($this->setRecs) { $this->recs[$row['uid']] = $row; }
463
464 // Accumulate the id of the element in the internal arrays
465 $this->ids[]=$idH[$row['uid']]['uid'] = $row['uid'];
466 $this->ids_hierarchy[$depth][] = $row['uid'];
467
468 // Make a recursive call to the next level
469 if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) {
470 $nextCount=$this->getTree(
471 $newID,
472 $depth-1,
473 $blankLineCode.','.$LN,
474 $row['_SUBCSSCLASS']
475 );
476 if (count($this->buffer_idH)) { $idH[$row['uid']]['subrow']=$this->buffer_idH; }
477 $exp = 1; // Set "did expand" flag
478 } else {
479 $nextCount = $this->getCount($newID);
480 $exp = 0; // Clear "did expand" flag
481 }
482
483 // Set HTML-icons, if any:
484 if ($this->makeHTML) {
485 if ($row['_FIRST_NOT_IN_MENU']) {
486 $HTML = '<img'.t3lib_iconWorks::skinImg($this->backPath, 'gfx/ol/line.gif').' alt="" /><br/><img'.t3lib_iconWorks::skinImg($this->backPath, 'gfx/ol/line.gif').' alt="" /><i>Not shown in menu'.$label_shownAlphabetically.':</i><br>';
487 } else {
488 $HTML = '';
489 }
490
491 $HTML.= $this->PMicon($row, $a, $c, $nextCount, $exp);
492 $HTML.= $this->wrapStop($this->getIcon($row), $row);
493 }
494
495 // Finally, add the row/HTML content to the ->tree array in the reserved key.
496 $this->tree[$treeKey] = array(
497 'row' => $row,
498 'HTML' => $HTML,
499 'hasSub' => $nextCount && $this->expandNext($newID),
500 'isFirst'=> $a==1,
501 'isLast' => FALSE,
502 'invertedDepth'=> $depth,
503 'blankLineCode'=> $blankLineCode,
504 'bank' => $this->bank
505 );
506 }
507
508 if($a) { $this->tree[$treeKey]['isLast'] = TRUE; }
509
510 $this->getDataFree($res);
511 $this->buffer_idH = $idH;
512 return $c;
513 }
514 }
515 ?>