Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0  3.8.1  4.0.0  4.0.1  4.1.0   <- Available in other TYPO3 versions

class.t3lib_treeview.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2005 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  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
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
require_once (PATH_t3lib.'class.t3lib_iconworks.php');
require_once (PATH_t3lib.'class.t3lib_befunc.php');
require_once (PATH_t3lib.'class.t3lib_div.php');


class t3lib_treeView {

                // EXTERNAL, static:
        var $expandFirst=0;             // If set, the first element in the tree is always expanded.
        var $expandAll=0;               // If set, then ALL items will be expanded, regardless of stored settings.
        var $thisScript='';             // Holds the current script to reload to.
        var $titleAttrib = 'title';             // Which HTML attribute to use: alt/title. See init().
        var $ext_IconMode = false;              // If true, no context menu is rendered on icons. If set to "titlelink" the icon is linked as the title is.
        var $addSelfId = 0;                             // If set, the id of the mounts will be added to the internal ids array
        var $title='no title';                  // Used if the tree is made of records (not folders for ex.)

        var $BE_USER='';

        var $MOUNTS='';



        var $table='';

        var $parentField='pid';

        var $clause='';

        var $orderByFields='';

        var $fieldArray = Array('uid','title');

        var $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id';


        var $treeName = '';

        var $domIdPrefix = 'row';

        var $backPath;

        var $iconPath = '';


        var $iconName = 'default.gif';

        var $makeHTML=1;

        var $setRecs = 0;

        var $subLevelID = '_SUB_LEVEL';




                // *********
                // Internal
                // *********
                // For record trees:
        var $ids = Array();                             // one-dim array of the uid's selected.
        var $ids_hierarchy = array();   // The hierarchy of element uids
        var $buffer_idH = array();              // Temporary, internal array

                // For FOLDER trees:
        var $specUIDmap=array();                // Special UIDs for folders (integer-hashes of paths)

                // For arrays:
        var $data = false;                              // Holds the input data array
        var $dataLookup = false;                // Holds an index with references to the data array.

                // For both types
        var $tree = Array();                    // Tree is accumulated in this variable
        var $stored = array();                  // Holds (session stored) information about which items in the tree are unfolded and which are not.
        var $bank=0;                                    // Points to the current mountpoint key
        var $recs = array();                    // Accumulates the displayed records.







        function init($clause='', $orderByFields='')    {
                $this->BE_USER = $GLOBALS['BE_USER'];   // Setting BE_USER by default
                $this->titleAttrib = 'title';   // Setting title attribute to use.
                $this->backPath = $GLOBALS['BACK_PATH'];        // Setting backpath.

                if ($clause)    $this->clause = $clause;        // Setting clause
                if ($orderByFields)     $this->orderByFields = $orderByFields;

                if (!is_array($this->MOUNTS))   {
                        $this->MOUNTS = array(0 => 0); // dummy
                }

                $this->setTreeName();

                if($this->table) {
                        t3lib_div::loadTCA($this->table);
                }

                        // setting this to false disables the use of array-trees by default
                $this->data = false;
                $this->dataLookup = false;
        }


        function setTreeName($treeName='') {
                $this->treeName = $treeName ? $treeName : $this->treeName;
                $this->treeName = $this->treeName ? $this->treeName : $this->table;
                $this->treeName = str_replace('_','',$this->treeName);
        }


        function addField($field,$noCheck=0)    {
                global $TCA;
                if ($noCheck || is_array($TCA[$this->table]['columns'][$field]) || t3lib_div::inList($this->defaultList,$field))        {
                        $this->fieldArray[]=$field;
                }
        }



        function reset()        {
                $this->tree = array();
                $this->recs = array();
                $this->ids = array();
                $this->ids_hierarchy = array();
        }


        /*******************************************
         *
         * output
         *
         *******************************************/

        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;

                                // 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;
                        $icon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($isOpen?'minus':'plus').'only.gif','width="18" height="16"').' alt="" />';
                        $firstHtml= $this->PM_ATagWrap($icon,$cmd);

                                // 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)) {
                                        // Add the root of the mount to ->tree
                                $this->tree[]=array('HTML'=>$firstHtml,'row'=>$rootRec,'bank'=>$this->bank);

                                        // If the mount is expanded, go down:
                                if ($isOpen)    {
                                                // Set depth:
                                        $depthD='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/blank.gif','width="18" height="16"').' alt="" />';
                                        if ($this->addSelfId)   $this->ids[] = $uid;
                                        $this->getTree($uid,999,$depthD);
                                }

                                        // Add tree:
                                $treeArr=array_merge($treeArr,$this->tree);
                        }
                }
                return $this->printTree($treeArr);
        }

        function printTree($treeArr='') {
                $titleLen=intval($this->BE_USER->uc['titleLen']);
                if (!is_array($treeArr))        $treeArr=$this->tree;
                $out='';

                        // put a table around it with IDs to access the rows from JS
                        // not a problem if you don't need it
                        // In XHTML there is no "name" attribute of <td> elements - but Mozilla will not be able to highlight rows if the name attribute is NOT there.
                $out .= '

                        <!--
                          TYPO3 tree structure.
                        -->
                        <table cellpadding="0" cellspacing="0" border="0" id="typo3-tree">';

                foreach($treeArr as $k => $v)   {
                        $idAttr = htmlspecialchars($this->domIdPrefix.$this->getId($v['row']).'_'.$v['bank']);
                        $out.='
                                <tr>
                                        <td id="'.$idAttr.'">'.
                                                $v['HTML'].
                                                $this->wrapTitle($this->getTitleStr($v['row'],$titleLen),$v['row'],$v['bank']).
                                        '</td>
                                </tr>
                        ';
                }
                $out .= '
                        </table>';
                return $out;
        }



        /*******************************************
         *
         * rendering parts
         *
         *******************************************/



        function PMicon($row,$a,$c,$nextCount,$exp)     {
                $PM = $nextCount ? ($exp?'minus':'plus') : 'join';
                $BTM = ($a==$c)?'bottom':'';
                $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' alt="" />';

                if ($nextCount) {
                        $cmd=$this->bank.'_'.($exp?'0_':'1_').$row['uid'].'_'.$this->treeName;
                        $bMark=($this->bank.'_'.$row['uid']);
                        $icon = $this->PM_ATagWrap($icon,$cmd,$bMark);
                }
                return $icon;
        }

        function PM_ATagWrap($icon,$cmd,$bMark='')      {
                if ($this->thisScript) {
                        if ($bMark)     {
                                $anchor = '#'.$bMark;
                                $name=' name="'.$bMark.'"';
                        }
                        $aUrl = $this->thisScript.'?PM='.$cmd.$anchor;
                        return '<a href="'.htmlspecialchars($aUrl).'"'.$name.'>'.$icon.'</a>';
                } else {
                        return $icon;
                }
        }

        function wrapTitle($title,$row,$bank=0) {
                $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->domIdPrefix.$this->getId($row).'_'.$bank.'\');';
                return '<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$title.'</a>';
        }

        function wrapIcon($icon,$row)   {
                return $icon;
        }

        function addTagAttributes($icon,$attr)  {
                return ereg_replace(' ?\/?>$','',$icon).' '.$attr.' />';
        }

        function wrapStop($str,$row)    {
                if ($row['php_tree_stop'])      {
                        $str.='<span class="typo3-red">+ </span>';
                }
                return $str;
        }






        /*******************************************
         *
         * tree handling
         *
         *******************************************/


        function expandNext($id)        {
                return ($this->stored[$this->bank][$id] || $this->expandAll)? 1 : 0;
        }

        function initializePositionSaving()     {
                        // Get stored tree structure:
                $this->stored=unserialize($this->BE_USER->uc['browseTrees'][$this->treeName]);

                        // PM action
                        // (If an plus/minus icon has been clicked, the PM GET var is sent and we must update the stored positions in the tree):
                $PM = explode('_',t3lib_div::_GP('PM'));        // 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName
                if (count($PM)==4 && $PM[3]==$this->treeName)   {
                        if (isset($this->MOUNTS[$PM[0]]))       {
                                if ($PM[1])     {       // set
                                        $this->stored[$PM[0]][$PM[2]]=1;
                                        $this->savePosition();
                                } else {        // clear
                                        unset($this->stored[$PM[0]][$PM[2]]);
                                        $this->savePosition();
                                }
                        }
                }
        }

        function savePosition() {
                $this->BE_USER->uc['browseTrees'][$this->treeName] = serialize($this->stored);
                $this->BE_USER->writeUC();
        }













        /******************************
         *
         * Functions that might be overwritten by extended classes
         *
         ********************************/

        function getRootIcon($rec) {
                return $this->wrapIcon('<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif','width="18" height="16"').' alt="" />',$rec);
        }



        function getIcon($row) {
                if ($this->iconPath && $this->iconName) {
                        $icon = '<img'.t3lib_iconWorks::skinImg('',$this->iconPath.$this->iconName,'width="18" height="16"').' alt="" />';
                } else {
                        $icon = t3lib_iconWorks::getIconImage($this->table,$row,$this->backPath,'align="top" class="c-recIcon"');
                }

                return $this->wrapIcon($icon,$row);
        }


        function getTitleStr($row,$titleLen=30) {
                $title = (!strcmp(trim($row['title']),'')) ? '<em>['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title',1).']</em>' : htmlspecialchars(t3lib_div::fixed_lgd_cs($row['title'],$titleLen));
                return $title;
        }

        function getTitleAttrib($row) {
                return htmlspecialchars($row['title']);
        }

        function getId($row) {
                return $row['uid'];
        }

        function getJumpToParam($row) {
                return $this->getId($row);
        }















        /********************************
         *
         * tree data buidling
         *
         ********************************/

        function getTree($uid, $depth=999, $depthData='',$blankLineCode='')     {

                        // Buffer for id hierarchy is reset:
                $this->buffer_idH=array();


                        // Init vars
                $depth=intval($depth);
                $HTML='';
                $a=0;

                $res = $this->getDataInit($uid);
                $c = $this->getDataCount($res);
                $crazyRecursionLimiter = 999;

                        // Traverse the records:
                while ($crazyRecursionLimiter>0 && $row = $this->getDataNext($res))     {
                        $a++;
                        $crazyRecursionLimiter--;

                        $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,
                                                $this->makeHTML?$depthData.'<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$LN.'.gif','width="18" height="16"').' alt="" />':'',
                                                $blankLineCode.','.$LN
                                        );
                                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)    {
                                $HTML = $depthData.$this->PMicon($row,$a,$c,$nextCount,$exp);
                                $HTML.=$this->wrapStop($this->getIcon($row),$row);
                                #       $HTML.=$this->wrapStop($this->wrapIcon($this->getIcon($row),$row),$row);
                        }

                                // Finally, add the row/HTML content to the ->tree array in the reserved key.
                        $this->tree[$treeKey] = Array(
                                'row'=>$row,
                                'HTML'=>$HTML,
                                'invertedDepth'=>$depth,
                                'blankLineCode'=>$blankLineCode,
                                'bank' => $this->bank
                        );
                }

                $this->getDataFree($res);
                $this->buffer_idH=$idH;
                return $c;
        }












        /********************************
         *
         * Data handling
         * Works with records and arrays
         *
         ********************************/

        function getCount($uid) {
                if (is_array($this->data)) {
                        $res = $this->getDataInit($uid);
                        return $this->getDataCount($res);
                } else {
                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                                'count(*)',
                                                $this->table,
                                                $this->parentField.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($uid, $this->table).
                                                        t3lib_BEfunc::deleteClause($this->table).
                                                        $this->clause,  // whereClauseMightContainGroupOrderBy
                                                '',
                                                '' //$this->orderByFields // sorting is senseless for count(*) !?!
                                        );
                        $row = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
                        return $row[0];
                }
        }



        function getRootRecord($uid) {
                return array('title'=>$this->title, 'uid'=>0);
        }


        function getRecord($uid) {
                if (is_array($this->data)) {
                        return $this->dataLookup[$uid];
                } else {
                        return t3lib_befunc::getRecord($this->table,$uid);
                }
        }

        function getDataInit($parentId) {
                if (is_array($this->data)) {
                        if (!is_array($this->dataLookup[$parentId][$this->subLevelID])) {
                                $parentId = -1;
                        } else {
                                reset($this->dataLookup[$parentId][$this->subLevelID]);
                        }
                        return $parentId;
                } else {
                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                                implode(',',$this->fieldArray),
                                                $this->table,
                                                $this->parentField.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($parentId, $this->table).
                                                        t3lib_BEfunc::deleteClause($this->table).
                                                        $this->clause,  // whereClauseMightContainGroupOrderBy
                                                '',
                                                $this->orderByFields
                                        );
                        return $res;
                }
        }

        function getDataCount(&$res) {
                if (is_array($this->data)) {
                        return count($this->dataLookup[$res][$this->subLevelID]);
                } else {
                        $c = $GLOBALS['TYPO3_DB']->sql_num_rows($res);
                        return $c;
                }
        }

        function getDataNext(&$res){
                if (is_array($this->data)) {
                        if ($res<0) {
                                $row=FALSE;
                        } else {
                                list(,$row) = each($this->dataLookup[$res][$this->subLevelID]);

                                /*
                                if (!is_array($row))    {
                                        $row=FALSE;
                                } else {
                                        unset($row['subLevel']);
                                }
                                */
                        }
                        return $row;
                } else {
                        return @$GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
                }
        }

        function getDataFree(&$res){
                if (is_array($this->data)) {
                #       unset();
                } else {
                        $GLOBALS['TYPO3_DB']->sql_free_result($res);
                }
        }

        function setDataFromArray(&$dataArr,$traverse=FALSE,$pid=0)     {
                if (!$traverse) {
                        $this->data = &$dataArr;
                        $this->dataLookup=array();
                                // add root
                        $this->dataLookup[0][$this->subLevelID]=&$dataArr;
                }

                foreach($dataArr as $uid => $val)       {

                        $dataArr[$uid]['uid']=$uid;
                        $dataArr[$uid]['pid']=$pid;

                                // gives quick access to id's
                        $this->dataLookup[$uid] = &$dataArr[$uid];

                        if (is_array($val[$this->subLevelID])) {
                                $this->setDataFromArray($dataArr[$uid][$this->subLevelID],TRUE,$uid);
                        }
                }
        }

        function setDataFromTreeArray(&$treeArr, &$treeLookupArr)       {
                $this->data = &$treeArr;
                $this->dataLookup=&$treeLookupArr;
        }


        /*
                array(
                        [id1] => array(
                                'title'=>'title...',
                                'id' => 'id1',
                                'icon' => 'icon ref, relative to typo3/ folder...'
                        ),
                        [id2] => array(
                                'title'=>'title...',
                                'id' => 'id2',
                                'icon' => 'icon ref, relative to typo3/ folder...'
                        ),
                        [id3] => array(
                                'title'=>'title...',
                                'id' => 'id3',
                                'icon' => 'icon ref, relative to typo3/ folder...'
                                $this->subLevelID => array(
                                        [id3_asdf#1] => array(
                                                'title'=>'title...',
                                                'id' => 'asdf#1',
                                                'icon' => 'icon ref, relative to typo3/ folder...'
                                        ),
                                        [5] => array(
                                                'title'=>'title...',
                                                'id' => 'id...',
                                                'icon' => 'icon ref, relative to typo3/ folder...'
                                        ),
                                        [6] => array(
                                                'title'=>'title...',
                                                'id' => 'id...',
                                                'icon' => 'icon ref, relative to typo3/ folder...'
                                        ),
                                )
                        ),
                )
*/
}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_treeview.php'])  {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_treeview.php']);
}
?>

---