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