This commit was manufactured by cvs2svn to create tag
[Packages/TYPO3.CMS.git] / typo3 / alt_db_navframe.php
index 332e317..a6c177e 100755 (executable)
@@ -1,19 +1,19 @@
 <?php
 /***************************************************************
 *  Copyright notice
-*  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*
+*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
-*  This script is part of the TYPO3 project. The TYPO3 project is 
+*  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
-* 
+*
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
-*  A copy is found in the textfile GPL.txt and important notices to the license 
+*  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 /**
- * Page tree for the Web module
+ * Page navigation tree for the Web module
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
- * @package TYPO3
- * @subpackage core
+ * $Id$
+ * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
+ * XHTML compliant
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ */
+/**
+ * [CLASS/FUNCTION INDEX of SCRIPT]
+ *
+ *
+ *
+ *   72: class localPageTree extends t3lib_browseTree
+ *   79:     function localPageTree()
+ *   90:     function wrapIcon($icon,&$row)
+ *
+ *
+ *  131: class SC_alt_db_navframe
+ *  147:     function init()
+ *  235:     function main()
+ *  263:     function printContent()
+ *
+ * TOTAL FUNCTIONS: 5
+ * (This index is automatically created/updated by the extension "extdeveval")
  *
- * Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
- * XHTML compliant (almost)
  */
 
 
@@ -43,83 +61,136 @@ require_once (PATH_t3lib.'class.t3lib_browsetree.php');
 
 
 
-// ***************************
-// Script Classes
-// ***************************
 /**
  * Extension class for the t3lib_browsetree class, specially made for browsing pages in the Web module
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage core
  * @see class t3lib_browseTree
  */
 class localPageTree extends t3lib_browseTree {
 
+       var $ext_showPageId;
+       var $ext_IconMode;
+
+       /**
+        * Calls init functions
+        *
+        * @return      void
+        */
        function localPageTree() {
                $this->init();
        }
 
+       /**
+        * Wrapping icon in browse tree
+        *
+        * @param       string          Icon IMG code
+        * @param       array           Data row for element.
+        * @return      string          Page icon
+        */
        function wrapIcon($icon,&$row)  {
                        // If the record is locked, present a warning sign.
-               if ($lockInfo=t3lib_BEfunc::isRecordLocked("pages",$row["uid"]))        {
-                       $aOnClick = 'alert('.$GLOBALS['LANG']->JScharCode($lockInfo["msg"]).');return false;';
+               if ($lockInfo=t3lib_BEfunc::isRecordLocked('pages',$row['uid']))        {
+                       $aOnClick = 'alert('.$GLOBALS['LANG']->JScharCode($lockInfo['msg']).');return false;';
                        $lockIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.
-                               '<img src="gfx/recordlock_warning3.gif" width="17" height="12" vspace=2 border="0" align=top'.t3lib_BEfunc::titleAttrib($lockInfo["msg"]).' alt="" />'.
+                               '<img'.t3lib_iconWorks::skinImg('','gfx/recordlock_warning3.gif','width="17" height="12"').' title="'.htmlspecialchars($lockInfo['msg']).'" alt="" />'.
                                '</a>';
                } else $lockIcon="";
 
                        // Add title attribute to input icon tag
-               $thePageIcon = substr($icon,0,-1).' '.$this->titleAttrib.'="'.$this->getTitleAttrib($row).'" border="0" />';
+               $thePageIcon = $this->addTagAttributes($icon, $this->titleAttrib.'="'.$this->getTitleAttrib($row).'"');
 
                        // Wrap icon in click-menu link.
                if (!$this->ext_IconMode)       {
-                       $thePageIcon = $GLOBALS["TBE_TEMPLATE"]->wrapClickMenuOnIcon($thePageIcon,'pages',$row['uid'],0);
+                       $thePageIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($thePageIcon,'pages',$row['uid'],0);
                } elseif (!strcmp($this->ext_IconMode,'titlelink'))     {
                        $aOnClick = 'return jumpTo('.$this->getJumpToParm($row).',this,\''.$this->treeName.'\');';
                        $thePageIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$thePageIcon.'</a>';
                }
-               return $thePageIcon.$lockIcon;
+
+                       // Add Page ID:
+               if ($this->ext_showPageId)      {
+                       $pageIdStr = '['.$row['uid'].']&nbsp;';
+               } else {
+                       $pageIdStr = '';
+               }
+
+               return $thePageIcon.$lockIcon.$pageIdStr;
        }
 }
 
+
+
+
+
+
+
+
+
+
+
+
 /**
- * Main script class
+ * Main script class for the page tree navigation frame
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage core
  */
 class SC_alt_db_navframe {
+
+               // Internal:
        var $content;
        var $pagetree;
-       var $doc;       
-       
+       var $doc;
+
+               // Internal, static: GPvar:
+       var $currentSubScript;
+       var $cMR;
+
        /**
-        * Initialiation
+        * Initialiation of the class
+        *
+        * @return      void
         */
        function init() {
                global $BE_USER,$BACK_PATH;
 
+                       // Setting GPvars:
+               $this->currentSubScript = t3lib_div::_GP('currentSubScript');
+               $this->cMR = t3lib_div::_GP('cMR');
+
+                       // Create page tree object:
                $this->pagetree = t3lib_div::makeInstance('localPageTree');
                $this->pagetree->ext_IconMode = $BE_USER->getTSConfigVal('options.pageTree.disableIconLinkToContextmenu');
+               $this->pagetree->ext_showPageId = $BE_USER->getTSConfigVal('options.pageTree.showPageIdWithTitle');
                $this->pagetree->thisScript = 'alt_db_navframe.php';
                $this->pagetree->addField('alias');
                $this->pagetree->addField('shortcut');
                $this->pagetree->addField('shortcut_mode');
                $this->pagetree->addField('mount_pid');
+               $this->pagetree->addField('mount_pid_ol');
+               $this->pagetree->addField('nav_hide');
                $this->pagetree->addField('url');
 
-               $currentSubScript = t3lib_div::GPvar('currentSubScript');
-
+                       // Setting highlight mode:
                $this->doHighlight = !$BE_USER->getTSConfigVal('options.pageTree.disableTitleHighlight');
 
                        // Create template object:
                $this->doc = t3lib_div::makeInstance('template');
-
-                       // Hmmm, setting "xhtml_trans" for the page will unfortunately break the Context Sensitive menu in Mozilla! But apart from that - and duplicate ID's for same page in different  mounts - the document checks out well as XHTML
-#              $this->doc->docType='xhtml_trans';
+               $this->doc->docType='xhtml_trans';
 
                        // Setting backPath
                $this->doc->backPath = $BACK_PATH;
 
                        // Setting JavaScript for menu.
                $this->doc->JScode=$this->doc->wrapScriptTags(
-       ($currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($currentSubScript).'");':'').'
-       
-       function jumpTo(id,linkObj)     {
+       ($this->currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($this->currentSubScript).'");':'').'
+
+               // Function, loading the list frame from navigation tree:
+       function jumpTo(id,linkObj,highLightID) {       //
                var theUrl = top.TS.PATH_typo3+top.currentSubScript+"?id="+id;
 
                if (top.condensedMode)  {
@@ -127,46 +198,40 @@ class SC_alt_db_navframe {
                } else {
                        parent.list_frame.document.location=theUrl;
                }
-        '.($this->doHighlight?'hilight_row("pages"+top.fsMod.recentIds["web"],"pages"+id);':'').'
+
+               '.($this->doHighlight?'hilight_row("web",highLightID);':'').'
+
                '.(!$GLOBALS['CLIENT']['FORMSTYLE'] ? '' : 'if (linkObj) {linkObj.blur();}').'
                return false;
        }
-       function refresh_nav()  {
+
+               // Call this function, refresh_nav(), from another script in the backend if you want to refresh the navigation frame (eg. after having changed a page title or moved pages etc.)
+               // See t3lib_BEfunc::getSetUpdateSignal()
+       function refresh_nav()  {       //
                window.setTimeout("_refresh_nav();",0);
        }
-       function _refresh_nav() {
+       function _refresh_nav() {       //
                document.location="'.$this->pagetree->thisScript.'?unique='.time().'";
        }
 
-    function hilight_row(old_rowid,new_rowid) {
-       if(document.all) {
-         if(document.all.item(old_rowid)) {
-           document.all.item(old_rowid).style.backgroundColor="";
-         }
-         if(document.all.item(new_rowid)) {
-          document.all.item(new_rowid).style.backgroundColor="'.
-                       t3lib_div::modifyHTMLColorAll($this->doc->bgColor,-20).
-                       '";
-         }
-       } else {
-         if(document.getElementsByName) {
-           old_row_obj = document.getElementsByName(old_rowid)[0];
-           new_row_obj = document.getElementsByName(new_rowid)[0];
-           bgc = document.createAttribute("bgcolor");
-           bgc.value="'.
-                       t3lib_div::modifyHTMLColorAll($this->doc->bgColor,-20).
-                       '";
-           if(old_row_obj) {
-             old_row_obj.removeAttribute("bgcolor");
-           }
-           if(new_row_obj) {
-             new_row_obj.setAttributeNode(bgc);
-           }
-         }
-       }
-    }
-       
-       '.(t3lib_div::GPvar('cMR')?"jumpTo(top.fsMod.recentIds['web'],'');":"").';
+               // Highlighting rows in the page tree:
+       function hilight_row(frameSetModule,highLightID) {      //
+
+                       // Remove old:
+               theObj = document.getElementById(top.fsMod.navFrameHighlightedID[frameSetModule]);
+               if (theObj)     {
+                       theObj.style.backgroundColor="";
+               }
+
+                       // Set new:
+               top.fsMod.navFrameHighlightedID[frameSetModule] = highLightID;
+               theObj = document.getElementById(highLightID);
+               if (theObj)     {
+                       theObj.style.backgroundColor="'.t3lib_div::modifyHTMLColorAll($this->doc->bgColor,-20).'";
+               }
+       }
+
+       '.($this->cMR?"jumpTo(top.fsMod.recentIds['web'],'');":'').';
                ');
 
                        // Click menu code is added:
@@ -177,38 +242,37 @@ class SC_alt_db_navframe {
        }
 
        /**
-        * Main function
+        * Main function, rendering the browsable page tree
+        *
+        * @return      void
         */
        function main() {
                global $LANG,$CLIENT;
 
                        // Produce browse-tree:
                $tree = $this->pagetree->getBrowsableTree();
-               /*
-               if ($CLIENT['BROWSER']=='konqu')        {
-                               // Where <nobr> does not work, this will secure non-breaks in lines:
-                       $tree = '<table border=0 cellspacing=0 cellpadding=0><tr><td nowrap>'.$tree.'</td></tr></table>';
-               }
-               */
 
                $this->content='';
                $this->content.=$this->doc->startPage('Page tree');
                $this->content.=$tree;
-               $this->content.='<br />
-                       <a href="'.htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')).'">'.
-                       '<img src="gfx/refresh_n.gif" width="14" hspace="2" height="14" hspace="4" border="0" align="top" title="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'" alt="" />'.
-                       $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'</a>
-                       <br /><br />';
+               $this->content.='
+                       <p class="c-refresh">
+                               <a href="'.htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')).'">'.
+                               '<img'.t3lib_iconWorks::skinImg('','gfx/refresh_n.gif','width="14" height="14"').' title="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'" alt="" />'.
+                               $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'</a>
+                       </p>
+                       <br />';
 
                        // Adding highlight - JavaScript
                if ($this->doHighlight) $this->content .=$this->doc->wrapScriptTags('
-                       rowid="pages"+top.fsMod.recentIds["web"];
-                       hilight_row("",rowid);
+                       hilight_row("",top.fsMod.navFrameHighlightedID["web"]);
                ');
        }
 
        /**
-        * Output tree.
+        * Outputting the accumulated content to screen
+        *
+        * @return      void
         */
        function printContent() {
                $this->content.= $this->doc->endPage();