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