t3lib/class.t3lib_pagetree.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, non-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  *   78: class t3lib_pageTree extends t3lib_treeView
  41  *   90:         function init($clause='')
  42  *  106:         function expandNext($id)
  43  *  123:         function PMicon($row,$a,$c,$nextCount,$exp)
  44  *  138:         function initializePositionSaving()
  45  *
  46  * TOTAL FUNCTIONS: 4
  47  * (This index is automatically created/updated by the extension "extdeveval")
  48  *
  49  */
  50
  51
  52 /**
  53  * Class for generating a page tree.
  54  *
  55  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
  56  * @coauthor    René Fritz <r.fritz@colorcube.de>
  57  * @see t3lib_treeView, t3lib_browseTree
  58  * @package TYPO3
  59  * @subpackage t3lib
  60  */
  61 class t3lib_pageTree extends t3lib_treeView {
  62         var $fieldArray = array(
  63                 'uid',
  64                 'title',
  65                 'doktype',
  66                 'php_tree_stop',
  67                 't3ver_id',
  68                 't3ver_state',
  69                 't3ver_swapmode'
  70         );
  71         var $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id';
  72         var $setRecs = 0;
  73
  74         /**
  75          * Init function
  76          * REMEMBER to feed a $clause which will filter out non-readable pages!
  77          *
  78          * @param       string          Part of where query which will filter out non-readable pages.
  79          * @return      void
  80          */
  81         function init($clause = '') {
  82                 parent::init(' AND deleted=0 ' . $clause, 'sorting');
  83
  84                 if (t3lib_extMgm::isLoaded('cms')) {
  85                         $this->fieldArray = array_merge(
  86                                 $this->fieldArray,
  87                                 array(
  88                                          'hidden',
  89                                          'starttime',
  90                                          'endtime',
  91                                          'fe_group',
  92                                          'module',
  93                                          'extendToSubpages',
  94                                          'nav_hide')
  95                         );
  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
 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') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagetree.php'])) {
 147         include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_pagetree.php']);
 148 }
 149 ?>