* @author Benjamin Mack * * * [CLASS/FUNCTION INDEX of SCRIPT] * * * * 71: class webPageTree extends t3lib_browseTree * 81: function webPageTree() * 92: function wrapIcon($icon,&$row) * 130: function wrapStop($str,$row) * 146: function wrapTitle($title,$row,$bank=0) * 165: function printTree($treeArr = '') * 271: function PMicon($row,$a,$c,$nextCount,$exp) * 292: function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) * 309: function getBrowsableTree() * 377: function getTree($uid, $depth=999, $depthData='',$blankLineCode='',$subCSSclass='') * * * TOTAL FUNCTIONS: 9 * (This index is automatically created/updated by the extension "extdeveval") * */ /** * Extension class for the t3lib_browsetree class, specially made * for browsing pages in the Web module * * @author Kasper Skårhøj * @author Benjamin Mack * @package TYPO3 * @subpackage core * @see class t3lib_browseTree */ class webPageTree extends t3lib_browseTree { var $ext_showPageId; var $ext_IconMode; var $ext_separateNotinmenuPages; var $ext_alphasortNotinmenuPages; var $ajaxStatus = FALSE; // Indicates, whether the ajax call was successful, i.e. the requested page has been found /** * Calls init functions * * @return void */ function __construct() { $this->init(); } /** * Compatibility constructor. * * @deprecated since TYPO3 4.6 and will be removed in TYPO3 6.0. Use __construct() instead. */ public function webPageTree() { t3lib_div::logDeprecatedFunction(); // Note: we cannot call $this->__construct() here because it would call the derived class constructor and cause recursion // This code uses official PHP behavior (http://www.php.net/manual/en/language.oop5.basic.php) when $this in the // statically called non-static method inherits $this from the caller's scope. webPageTree::__construct(); } /** * Wrapping icon in browse tree * * @param string Icon IMG code * @param array Data row for element. * @return string Page icon */ function wrapIcon($thePageIcon, &$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;'; $lockIcon=''. t3lib_iconWorks::getSpriteIcon('status-warning-in-use',array('title'=>htmlspecialchars($lockInfo['msg']))). ''; } else $lockIcon = ''; // Wrap icon in click-menu link. if (!$this->ext_IconMode) { $thePageIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($thePageIcon,'pages',$row['uid'],0,'&bank='.$this->bank); } elseif (!strcmp($this->ext_IconMode,'titlelink')) { $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->treeName.'\');'; $thePageIcon=''.$thePageIcon.''; } // Wrap icon in a drag/drop span. $dragDropIcon = ''.$thePageIcon.''; // Add Page ID: $pageIdStr = ''; if ($this->ext_showPageId) { $pageIdStr = '[' . $row['uid'] . '] '; } // Call stats information hook $stat = ''; if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'])) { $_params = array('pages',$row['uid']); foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'] as $_funcRef) { $stat.=t3lib_div::callUserFunction($_funcRef,$_params,$this); } } return $dragDropIcon.$lockIcon.$pageIdStr.$stat; } /** * Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set * * @param string Input string, like a page title for the tree * @param array record row with "php_tree_stop" field * @return string Modified string * @access private */ function wrapStop($str,$row) { if ($row['php_tree_stop']) { $str.='+ '; } return $str; } /** * Wrapping $title in a-tags. * * @param string Title string * @param string Item record * @param integer Bank pointer (which mount point number) * @return string * @access private */ function wrapTitle($title,$row,$bank=0) { // Hook for overriding the page title if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'])) { $_params = array('title' => &$title, 'row' => &$row); foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'] as $_funcRef) { t3lib_div::callUserFunction($_funcRef, $_params, $this); } unset($_params); } $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->domIdPrefix.$this->getId($row).'\','.$bank.');'; $CSM = ' oncontextmenu="'.htmlspecialchars($GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon('','pages',$row['uid'],0,'&bank='.$this->bank,'',TRUE)).';"'; $thePageTitle=''.$title.''; // Wrap title in a drag/drop span. return ''.$thePageTitle.''; } /** * Compiles the HTML code for displaying the structure found inside the ->tree array * * @param array "tree-array" - if blank string, the internal ->tree array is used. * @return string The HTML code for the tree */ function printTree($treeArr = '') { $titleLen = intval($this->BE_USER->uc['titleLen']); if (!is_array($treeArr)) { $treeArr = $this->tree; } $out = '
    '; // -- evaluate AJAX request // IE takes anchor as parameter $PM = t3lib_div::_GP('PM'); if(($PMpos = strpos($PM, '#')) !== FALSE) { $PM = substr($PM, 0, $PMpos); } $PM = explode('_', $PM); if ((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) && is_array($PM) && count($PM) == 4 && $PM[2] != 0) { if($PM[1]) { $expandedPageUid = $PM[2]; $ajaxOutput = ''; $invertedDepthOfAjaxRequestedItem = 0; // We don't know yet. Will be set later. $doExpand = TRUE; } else { $collapsedPageUid = $PM[2]; $doCollapse = TRUE; } } // we need to count the opened
      's every time we dig into another level, // so we know how many we have to close when all children are done rendering $closeDepth = array(); foreach($treeArr as $k => $v) { $classAttr = $v['row']['_CSSCLASS']; $uid = $v['row']['uid']; $idAttr = htmlspecialchars($this->domIdPrefix.$this->getId($v['row']).'_'.$v['bank']); $itemHTML = ''; // if this item is the start of a new level, // then a new level
        is needed, but not in ajax mode if($v['isFirst'] && !($doCollapse) && !($doExpand && $expandedPageUid == $uid)) { $itemHTML = '
          '; } // add CSS classes to the list item if($v['hasSub']) { $classAttr .= ($classAttr) ? ' expanded': 'expanded'; } if($v['isLast']) { $classAttr .= ($classAttr) ? ' last' : 'last'; } $itemHTML .='
        • '. $v['HTML']. $this->wrapTitle($this->getTitleStr($v['row'],$titleLen),$v['row'],$v['bank'])."
          \n"; if(!$v['hasSub']) { $itemHTML .= '
        • '; } // we have to remember if this is the last one // on level X so the last child on level X+1 closes the
            -tag if($v['isLast'] && !($doExpand && $expandedPageUid == $uid)) { $closeDepth[$v['invertedDepth']] = 1; } // if this is the last one and does not have subitems, we need to close // the tree as long as the upper levels have last items too if($v['isLast'] && !$v['hasSub'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) { for ($i = $v['invertedDepth']; $closeDepth[$i] == 1; $i++) { $closeDepth[$i] = 0; $itemHTML .= '
          '; } } // ajax request: collapse if($doCollapse && $collapsedPageUid == $uid) { $this->ajaxStatus = TRUE; return $itemHTML; } // ajax request: expand if($doExpand && $expandedPageUid == $uid) { $ajaxOutput .= $itemHTML; $invertedDepthOfAjaxRequestedItem = $v['invertedDepth']; } elseif($invertedDepthOfAjaxRequestedItem) { if($v['invertedDepth'] < $invertedDepthOfAjaxRequestedItem) { $ajaxOutput .= $itemHTML; } else { $this->ajaxStatus = TRUE; return $ajaxOutput; } } $out .= $itemHTML; } if($ajaxOutput) { $this->ajaxStatus = TRUE; return $ajaxOutput; } // finally close the first ul $out .= '
        '; return $out; } /** * Generate the plus/minus icon for the browsable tree. * * @param array record for the entry * @param integer The current entry number * @param integer The total number of entries. If equal to $a, a "bottom" element is returned. * @param integer The number of sub-elements to the current element. * @param boolean The element was expanded to render subelements if this flag is set. * @return string Image tag with the plus/minus icon. * @access private * @see t3lib_pageTree::PMicon() */ function PMicon($row,$a,$c,$nextCount,$exp) { $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join'; $BTM = ($a == $c) ? 'bottom' : ''; $icon = 'backPath,'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' alt="" />'; if ($nextCount) { $cmd = $this->bank.'_'.($exp?'0_':'1_').$row['uid'].'_'.$this->treeName; $icon = $this->PMiconATagWrap($icon,$cmd,!$exp); } return $icon; } /** * Wrap the plus/minus icon in a link * * @param string HTML string to wrap, probably an image tag. * @param string Command for 'PM' get var * @return string Link-wrapped input string * @access private */ function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) { if ($this->thisScript) { // activate dynamic ajax-based tree $js = htmlspecialchars('Tree.load(\''.$cmd.'\', '.intval($isExpand).', this);'); return ''.$icon.''; } else { return $icon; } } /** * Will create and return the HTML code for a browsable tree * Is based on the mounts found in the internal array ->MOUNTS (set in the constructor) * * @return string HTML code for the browsable tree */ function getBrowsableTree() { // Get stored tree structure AND updating it if needed according to incoming PM GET var. $this->initializePositionSaving(); // Init done: $titleLen = intval($this->BE_USER->uc['titleLen']); $treeArr = array(); // Traverse mounts: foreach($this->MOUNTS as $idx => $uid) { // Set first: $this->bank = $idx; $isOpen = $this->stored[$idx][$uid] || $this->expandFirst || $uid === '0'; // Save ids while resetting everything else. $curIds = $this->ids; $this->reset(); $this->ids = $curIds; // Set PM icon for root of mount: $cmd = $this->bank.'_'.($isOpen? "0_" : "1_").$uid.'_'.$this->treeName; // only, if not for uid 0 if ($uid) { $icon = 'backPath,'gfx/ol/' . ($isOpen ? 'minus' :'plus' ) . 'only.gif') . ' alt="" />'; $firstHtml = $this->PMiconATagWrap($icon, $cmd, !$isOpen); } // Preparing rootRec for the mount if ($uid) { $rootRec = $this->getRecord($uid); $firstHtml.=$this->getIcon($rootRec); } else { // Artificial record for the tree root, id=0 $rootRec = $this->getRootRecord($uid); $firstHtml.=$this->getRootIcon($rootRec); } if (is_array($rootRec)) { // In case it was swapped inside getRecord due to workspaces. $uid = $rootRec['uid']; // Add the root of the mount to ->tree $this->tree[] = array('HTML'=>$firstHtml, 'row'=>$rootRec, 'bank'=>$this->bank, 'hasSub'=>TRUE, 'invertedDepth'=>1000); // If the mount is expanded, go down: if ($isOpen) { // Set depth: if ($this->addSelfId) { $this->ids[] = $uid; } $this->getTree($uid, 999, '', $rootRec['_SUBCSSCLASS']); } // Add tree: $treeArr=array_merge($treeArr,$this->tree); } } return $this->printTree($treeArr); } /** * Fetches the data for the tree * * @param integer item id for which to select subitems (parent id) * @param integer Max depth (recursivity limit) * @param string ? (internal) * @return integer The count of items on the level */ function getTree($uid, $depth=999, $blankLineCode='', $subCSSclass='') { // Buffer for id hierarchy is reset: $this->buffer_idH = array(); // Init vars $depth = intval($depth); $HTML = ''; $a = 0; $res = $this->getDataInit($uid, $subCSSclass); $c = $this->getDataCount($res); $crazyRecursionLimiter = 999; $inMenuPages = array(); $outOfMenuPages = array(); $outOfMenuPagesTextIndex = array(); while ($crazyRecursionLimiter > 0 && $row = $this->getDataNext($res,$subCSSclass)) { $crazyRecursionLimiter--; // Not in menu: if ($this->ext_separateNotinmenuPages && ($row['doktype'] == t3lib_pageSelect::DOKTYPE_BE_USER_SECTION || $row['doktype'] >= 200 || $row['nav_hide'])) { $outOfMenuPages[] = $row; $outOfMenuPagesTextIndex[] = ($row['doktype']>=200 ? 'zzz'.$row['doktype'].'_' : '').$row['title']; } else { $inMenuPages[] = $row; } } $label_shownAlphabetically = ""; if (count($outOfMenuPages)) { // Sort out-of-menu pages: $outOfMenuPages_alphabetic = array(); if ($this->ext_alphasortNotinmenuPages) { asort($outOfMenuPagesTextIndex); $label_shownAlphabetically = " (alphabetic)"; } foreach($outOfMenuPagesTextIndex as $idx => $txt) { $outOfMenuPages_alphabetic[] = $outOfMenuPages[$idx]; } // Merge: $outOfMenuPages_alphabetic[0]['_FIRST_NOT_IN_MENU']=TRUE; $allRows = array_merge($inMenuPages,$outOfMenuPages_alphabetic); } else { $allRows = $inMenuPages; } // Traverse the records: foreach ($allRows as $row) { $a++; $newID = $row['uid']; $this->tree[]=array(); // Reserve space. end($this->tree); $treeKey = key($this->tree); // Get the key for this space $LN = ($a==$c) ? 'blank' : 'line'; // If records should be accumulated, do so if ($this->setRecs) { $this->recs[$row['uid']] = $row; } // Accumulate the id of the element in the internal arrays $this->ids[]=$idH[$row['uid']]['uid'] = $row['uid']; $this->ids_hierarchy[$depth][] = $row['uid']; // Make a recursive call to the next level if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) { $nextCount=$this->getTree( $newID, $depth-1, $blankLineCode.','.$LN, $row['_SUBCSSCLASS'] ); if (count($this->buffer_idH)) { $idH[$row['uid']]['subrow']=$this->buffer_idH; } $exp = 1; // Set "did expand" flag } else { $nextCount = $this->getCount($newID); $exp = 0; // Clear "did expand" flag } // Set HTML-icons, if any: if ($this->makeHTML) { if ($row['_FIRST_NOT_IN_MENU']) { $HTML = 'backPath,'gfx/ol/line.gif').' alt="" />
        backPath,'gfx/ol/line.gif').' alt="" />Not shown in menu'.$label_shownAlphabetically.':
        '; } else { $HTML = ''; } $HTML.= $this->PMicon($row,$a,$c,$nextCount,$exp); $HTML.= $this->wrapStop($this->getIcon($row),$row); } // Finally, add the row/HTML content to the ->tree array in the reserved key. $this->tree[$treeKey] = array( 'row' => $row, 'HTML' => $HTML, 'hasSub' => $nextCount&&$this->expandNext($newID), 'isFirst'=> $a==1, 'isLast' => FALSE, 'invertedDepth'=> $depth, 'blankLineCode'=> $blankLineCode, 'bank' => $this->bank ); } if($a) { $this->tree[$treeKey]['isLast'] = TRUE; } $this->getDataFree($res); $this->buffer_idH = $idH; return $c; } } if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php'])) { include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php']); } ?>