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