Fixed bug #14050: CleanUp - CGL format of t3lib files - t3lib_positionmap
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_browsetree.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 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 * Generate a page-tree, browsable.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
32 *
33 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
34 * @coauthor René Fritz <r.fritz@colorcube.de>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 74: class t3lib_browseTree extends t3lib_treeView
42 * 83: function init($clause='')
43 * 116: function getTitleAttrib($row)
44 * 128: function wrapIcon($icon,$row)
45 * 150: function getTitleStr($row,$titleLen=30)
46 *
47 * TOTAL FUNCTIONS: 4
48 * (This index is automatically created/updated by the extension "extdeveval")
49 *
50 */
51
52
53 /**
54 * Extension class for the t3lib_treeView class, specially made for browsing pages
55 *
56 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
57 * @coauthor René Fritz <r.fritz@colorcube.de>
58 * @see t3lib_treeView, t3lib_pageTree
59 * @package TYPO3
60 * @subpackage t3lib
61 */
62 class t3lib_browseTree extends t3lib_treeView {
63
64 /**
65 * Initialize, setting what is necessary for browsing pages.
66 * Using the current user.
67 *
68 * @param string Additional clause for selecting pages.
69 * @return void
70 */
71 function init($clause = '') {
72
73 // this will hide records from display - it has nothing todo with user rights!!
74 $clauseExludePidList = '';
75 if ($pidList = $GLOBALS['BE_USER']->getTSConfigVal('options.hideRecords.pages')) {
76 if ($pidList = $GLOBALS['TYPO3_DB']->cleanIntList($pidList)) {
77 $clauseExludePidList = ' AND pages.uid NOT IN (' . $pidList . ')';
78 }
79 }
80
81 // This is very important for making trees of pages: Filtering out deleted pages, pages with no access to and sorting them correctly:
82 parent::init(' AND ' . $GLOBALS['BE_USER']->getPagePermsClause(1) . ' ' . $clause . $clauseExludePidList, 'sorting');
83
84 $this->table = 'pages';
85 $this->setTreeName('browsePages');
86 $this->domIdPrefix = 'pages';
87 $this->iconName = '';
88 $this->title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
89 $this->MOUNTS = $GLOBALS['WEBMOUNTS'];
90
91 if ($pidList) {
92 // Remove mountpoint if explicitely set in options.hideRecords.pages (see above)
93 $hideList = explode(',', $pidList);
94 $this->MOUNTS = array_diff($this->MOUNTS, $hideList);
95 }
96
97 $this->fieldArray = array_merge(
98 $this->fieldArray,
99 array('doktype', 'php_tree_stop', 't3ver_id', 't3ver_state', 't3ver_wsid', 't3ver_swapmode', 't3ver_state', 't3ver_move_id')
100 );
101 if (t3lib_extMgm::isLoaded('cms')) {
102 $this->fieldArray = array_merge(
103 $this->fieldArray,
104 array('hidden', 'starttime', 'endtime', 'fe_group', 'module', 'extendToSubpages', 'is_siteroot', 'nav_hide')
105 );
106 }
107 }
108
109 /**
110 * Creates title attribute content for pages.
111 * Uses API function in t3lib_BEfunc which will retrieve lots of useful information for pages.
112 *
113 * @param array The table row.
114 * @return string
115 */
116 function getTitleAttrib($row) {
117 return t3lib_BEfunc::titleAttribForPages($row, '1=1 ' . $this->clause, 0);
118 }
119
120 /**
121 * Wrapping the image tag, $icon, for the row, $row (except for mount points)
122 *
123 * @param string The image tag for the icon
124 * @param array The row for the current element
125 * @return string The processed icon input value.
126 * @access private
127 */
128 function wrapIcon($icon, $row) {
129 // Add title attribute to input icon tag
130 $theIcon = $this->addTagAttributes($icon, ($this->titleAttrib ? $this->titleAttrib . '="' . $this->getTitleAttrib($row) . '"' : ''));
131
132 // Wrap icon in click-menu link.
133 if (!$this->ext_IconMode) {
134 $theIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($theIcon, $this->treeName, $this->getId($row), 0);
135 } elseif (!strcmp($this->ext_IconMode, 'titlelink')) {
136 $aOnClick = 'return jumpTo(\'' . $this->getJumpToParam($row) . '\',this,\'' . $this->domIdPrefix . $this->getId($row) . '\',' . $this->bank . ');';
137 $theIcon = '<a href="#" onclick="' . htmlspecialchars($aOnClick) . '">' . $theIcon . '</a>';
138 }
139 return $theIcon;
140 }
141
142 /**
143 * Returns the title for the input record. If blank, a "no title" label (localized) will be returned.
144 * Do NOT htmlspecialchar the string from this function - has already been done.
145 *
146 * @param array The input row array (where the key "title" is used for the title)
147 * @param integer Title length (30)
148 * @return string The title.
149 */
150 function getTitleStr($row, $titleLen = 30) {
151 // get the basic title from the parent implementation in t3lib_treeview
152 $title = parent::getTitleStr($row, $titleLen);
153 if (isset($row['is_siteroot']) && $row['is_siteroot'] != 0 && $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.showDomainNameWithTitle')) {
154 $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('domainName,sorting', 'sys_domain',
155 'pid=' . $GLOBALS['TYPO3_DB']->quoteStr($row['uid'] . t3lib_BEfunc::deleteClause('sys_domain') . t3lib_BEfunc::BEenableFields('sys_domain'), 'sys_domain'), '', 'sorting', 1);
156 if (is_array($rows) && count($rows) > 0) {
157 $title = sprintf('%s [%s]', $title, htmlspecialchars($rows[0]['domainName']));
158 }
159 }
160 return $title;
161 }
162
163 /**
164 * Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
165 *
166 * @param string Input string, like a page title for the tree
167 * @param array record row with "php_tree_stop" field
168 * @return string Modified string
169 * @access private
170 */
171 function wrapStop($str, $row) {
172 if ($row['php_tree_stop']) {
173 $str .= '<span class="typo3-red">
174 <a href="' . htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => $row['uid']))) . '" class="typo3-red">+</a>
175 </span>';
176 }
177 return $str;
178 }
179 }
180
181 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_browsetree.php']) {
182 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_browsetree.php']);
183 }
184
185 ?>