Added feature #13953: Hookrequest - t3lib_page::getRecordOverlay (thanks to Tolleiv...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_pagetree.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 * Generate a page-tree, non-browsable.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 * @coauthor René Fritz <r.fritz@colorcube.de>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 78: class t3lib_pageTree extends t3lib_treeView
42 * 90: function init($clause='')
43 * 106: function expandNext($id)
44 * 123: function PMicon($row,$a,$c,$nextCount,$exp)
45 * 138: function initializePositionSaving()
46 *
47 * TOTAL FUNCTIONS: 4
48 * (This index is automatically created/updated by the extension "extdeveval")
49 *
50 */
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68 /**
69 * Class for generating a page tree.
70 *
71 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
72 * @coauthor René Fritz <r.fritz@colorcube.de>
73 * @see t3lib_treeView, t3lib_browseTree
74 * @package TYPO3
75 * @subpackage t3lib
76 */
77 class t3lib_pageTree extends t3lib_treeView {
78 var $fieldArray = array('uid', 'title', 'doktype', 'php_tree_stop', 't3ver_id', 't3ver_state', 't3ver_swapmode');
79 var $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id';
80 var $setRecs = 0;
81
82 /**
83 * Init function
84 * REMEMBER to feed a $clause which will filter out non-readable pages!
85 *
86 * @param string Part of where query which will filter out non-readable pages.
87 * @return void
88 */
89 function init($clause='') {
90 parent::init(' AND deleted=0 '.$clause, 'sorting');
91
92 if (t3lib_extMgm::isLoaded('cms')) {
93 $this->fieldArray = array_merge(
94 $this->fieldArray,
95 array('hidden', 'starttime', 'endtime', 'fe_group', 'module', 'extendToSubpages', 'nav_hide')
96 );
97 }
98 $this->table='pages';
99 $this->treeName='pages';
100 }
101
102 /**
103 * Returns true/false if the next level for $id should be expanded - and all levels should, so we always return 1.
104 *
105 * @param integer ID (uid) to test for (see extending classes where this is checked againts session data)
106 * @return boolean
107 */
108 function expandNext($id) {
109 return 1;
110 }
111
112 /**
113 * Generate the plus/minus icon for the browsable tree.
114 * In this case, there is no plus-minus icon displayed.
115 *
116 * @param array record for the entry
117 * @param integer The current entry number
118 * @param integer The total number of entries. If equal to $a, a 'bottom' element is returned.
119 * @param integer The number of sub-elements to the current element.
120 * @param boolean The element was expanded to render subelements if this flag is set.
121 * @return string Image tag with the plus/minus icon.
122 * @access private
123 * @see t3lib_treeView::PMicon()
124 */
125 function PMicon($row,$a,$c,$nextCount,$exp) {
126 $PM = 'join';
127 $BTM = ($a==$c)?'bottom':'';
128 $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' alt="" />';
129 return $icon;
130 }
131
132
133 /**
134 * Get stored tree structure AND updating it if needed according to incoming PM GET var.
135 * - Here we just set it to nothing since we want to just render the tree, nothing more.
136 *
137 * @return void
138 * @access private
139 */
140 function initializePositionSaving() {
141 $this->stored=array();
142 }
143 }
144
145
146 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagetree.php']) {
147 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagetree.php']);
148 }
149 ?>