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.db_list.inc

<?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!
***************************************************************/
class recordList extends t3lib_recordList {

                // External, static:
        var $tableList='';                                              // Specify a list of tables which are the only ones allowed to be displayed.
        var $returnUrl='';                                              // Return URL
        var $thumbs = 0;                                                // Boolean. Thumbnails on records containing files (pictures)
        var $itemsLimitPerTable = 20;                   // default Max items shown per table in "multi-table mode", may be overridden by tables.php
        var $itemsLimitSingleTable = 100;               // default Max items shown per table in "single-table mode", may be overridden by tables.php
        var $widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />';
        var $script = 'db_list.php';                    // Current script name
        var $allFields=0;                                               // Indicates if all available fields for a user should be selected or not.
        var $localizationView=FALSE;                    // Whether to show localization view or not.

                // Internal, static: GPvar:
        var $csvOutput=FALSE;                   // If set, csvList is outputted.
        var $sortField;                                 // Field, to sort list by
        var $sortRev;                                   // Field, indicating to sort in reverse order.
        var $displayFields;                             // Array, containing which fields to display in extended mode
        var $duplicateField;                    // String, can contain the field name from a table which must have duplicate values marked.

                // Internal, static:
        var $id;                                                // Page id
        var $table='';                                  // Tablename if single-table mode
        var $listOnlyInSingleTableMode=FALSE;   // If true, records are listed only if a specific table is selected.
        var $firstElementNumber=0;              // Pointer for browsing list
        var $searchString='';                   // Search string
        var $searchLevels='';                   // Levels to search down.
        var $showLimit=0;                               // Number of records to show
        var $pidSelect='';                              // List of ids from which to select/search etc. (when search-levels are set high). See start()
        var $perms_clause='';                   // Page select permissions
        var $calcPerms=0;                               // Some permissions...
        var $clickTitleMode = '';               // Mode for what happens when a user clicks the title of a record.
        var $modSharedTSconfig = array();               // Shared module configuration, used by localization features

                // Internal, dynamic:
        var $JScode = '';                               // JavaScript code accumulation
        var $HTMLcode = '';                             // HTML output
        var $iLimit=0;                                  // "LIMIT " in SQL...
        var $eCounter=0;                                // Counting the elements no matter what...
        var $totalItems='';                             // Set to the total number of items for a table when selecting.
        var $recPath_cache=array();             // Cache for record path
        var $setFields=array();                 // Fields to display for the current table
        var $currentTable = array();    // Used for tracking next/prev uids
        var $duplicateStack=array();    // Used for tracking duplicate values of fields





        function start($id,$table,$pointer,$search="",$levels="",$showLimit=0)  {
                global $TCA;

                        // Setting internal variables:
                $this->id=intval($id);                                  // sets the parent id
                if ($TCA[$table])       $this->table=$table;            // Setting single table mode, if table exists:
                $this->firstElementNumber=$pointer;
                $this->searchString=trim($search);
                $this->searchLevels=trim($levels);
                $this->showLimit=t3lib_div::intInRange($showLimit,0,10000);

                        // Setting GPvars:
                $this->csvOutput = t3lib_div::_GP('csv') ? TRUE : FALSE;
                $this->sortField = t3lib_div::_GP('sortField');
                $this->sortRev = t3lib_div::_GP('sortRev');
                $this->displayFields = t3lib_div::_GP('displayFields');
                $this->duplicateField = t3lib_div::_GP('duplicateField');

                        // If thumbnails are disabled, set the "notfound" icon as default:
                if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails'])  {
                        $this->thumbScript='gfx/notfound_thumb.gif';
                }

                        // Init dynamic vars:
                $this->counter=0;
                $this->JScode='';
                $this->HTMLcode='';

                        // Set select levels:
                $sL=intval($this->searchLevels);
                $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
                if ($sL>0)      {
                        $tree = $this->getTreeObject($id,$sL,$this->perms_clause);
                        $this->pidSelect = 'pid IN ('.implode(',',$tree->ids).')';
                } else {
                        $this->pidSelect = 'pid='.intval($id);
                }

                        // Initialize languages:
                if ($this->localizationView)    {
                        $this->initializeLanguages();
                }
        }

        function generateList() {
                global $TCA;

                        // Traverse the TCA table array:
                reset($TCA);
                while (list($tableName)=each($TCA))     {

                                // Checking if the table should be rendered:
                        if ((!$this->table || $tableName==$this->table) && (!$this->tableList || t3lib_div::inList($this->tableList,$tableName)) && $GLOBALS['BE_USER']->check('tables_select',$tableName))     {               // Checks that we see only permitted/requested tables:

                                        // Load full table definitions:
                                t3lib_div::loadTCA($tableName);

                                        // iLimit is set depending on whether we're in single- or multi-table mode
                                if ($this->table)       {
                                        $this->iLimit=(isset($TCA[$tableName]['interface']['maxSingleDBListItems'])?intval($TCA[$tableName]['interface']['maxSingleDBListItems']):$this->itemsLimitSingleTable);
                                } else {
                                        $this->iLimit=(isset($TCA[$tableName]['interface']['maxDBListItems'])?intval($TCA[$tableName]['interface']['maxDBListItems']):$this->itemsLimitPerTable);
                                }
                                if ($this->showLimit)   $this->iLimit = $this->showLimit;

                                        // Setting fields to select:
                                if ($this->allFields)   {
                                        $fields = $this->makeFieldList($tableName);
                                        $fields[]='_PATH_';
                                        $fields[]='_CONTROL_';
                                        if (is_array($this->setFields[$tableName]))     {
                                                $fields = array_intersect($fields,$this->setFields[$tableName]);
                                        } else {
                                                $fields = array();
                                        }
                                } else {
                                        $fields = array();
                                }

                                        // Finally, render the list:
                                $this->HTMLcode.=$this->getTable($tableName, $this->id,implode(',',$fields));
                        }
                }
        }

        function getSearchBox($formFields=1)    {

                        // Setting form-elements, if applicable:
                $formElements=array('','');
                if ($formFields)        {
                        $formElements=array('<form action="'.htmlspecialchars($this->listURL()).'" method="post">','</form>');
                }

                        // Make level selector:
                $opt=array();
                $parts = explode('|',$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.enterSearchLevels'));
                while(list($kv,$label)=each($parts))    {
                        $opt[] = '<option value="'.$kv.'"'.($kv==intval($this->searchLevels)?' selected="selected"':'').'>'.htmlspecialchars($label).'</option>';
                }
                $lMenu = '<select name="search_levels">'.implode('',$opt).'</select>';

                        // Table with the search box:
                $content.= '
                        '.$formElements[0].'

                                <!--
                                        Search box:
                                -->
                                <table border="0" cellpadding="0" cellspacing="0" class="bgColor4" id="typo3-dblist-search">
                                        <tr>
                                                <td>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.enterSearchString',1).'<input type="text" name="search_field" value="'.htmlspecialchars($this->searchString).'"'.$GLOBALS['TBE_TEMPLATE']->formWidth(10).' /></td>
                                                <td>'.$lMenu.'</td>
                                                <td><input type="submit" name="search" value="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.search',1).'" /></td>
                                        </tr>
                                        <tr>
                                                <td colspan="3">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showRecords',1).':<input type="text" name="showLimit" value="'.htmlspecialchars($this->showLimit?$this->showLimit:'').'"'.$GLOBALS['SOBE']->doc->formWidth(4).' /></td>
                                        </tr>
                                </table>
                        '.$formElements[1];
                $content.=t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_searchbox', $GLOBALS['BACK_PATH'],'|<br/>');
                return $content;
        }

        function showSysNotesForPage()  {
                global $TCA;

                $out='';

                        // Checking if extension is loaded:
                if (!t3lib_extMgm::isLoaded('sys_note'))        return '';

                        // Create query for selecting the notes:
                $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*','sys_note','pid IN ('.$this->id.') AND (personal=0 OR cruser='.intval($GLOBALS['BE_USER']->user['uid']).')'.t3lib_BEfunc::deleteClause('sys_note'));

                        // Executing query:
                $dbCount = $GLOBALS['TYPO3_DB']->sql_num_rows($result);

                        // If some notes were found, render them:
                if ($dbCount)   {
                        $cat = array();

                                // Load full table description:
                        t3lib_div::loadTCA('sys_note');

                                // Traverse note-types and get labels:
                        if ($TCA['sys_note'] && $TCA['sys_note']['columns']['category'] && is_array($TCA['sys_note']['columns']['category']['config']['items']))        {
                                foreach($TCA['sys_note']['columns']['category']['config']['items'] as $el)      {
                                        $cat[$el[1]]=$GLOBALS['LANG']->sL($el[0]);
                                }
                        }

                                // For each note found, make rendering:
                        while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result))    {

                                        // Create content:
                                $iconImg = t3lib_iconWorks::getIconImage('sys_note',$row,$this->backPath,'');
                                $subject = htmlspecialchars($row['subject']);
                                $fields = array();
                                $fields['Author:'] = htmlspecialchars($row['author'].($row['email'] && $row['author'] ? ', ':'').$row['email']);
                                $fields['Category:'] = htmlspecialchars($cat[$row['category']]);
                                $fields['Note:'] = nl2br(htmlspecialchars($row['message']));

                                        // Compile content:
                                $out.='


                                <!--
                                        Sys-notes for the db_list.php:
                                -->
                                        <table border="0" cellpadding="1" cellspacing="1" id="typo3-dblist-sysnotes">
                                                <tr><td colspan="2" class="bgColor2">'.$iconImg.'<strong>'.$subject.'</strong></td></tr>
                                                <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.category',1).'</td><td class="bgColor4">'.$fields['Category:'].'</td></tr>
                                                <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.author',1).'</td><td class="bgColor4">'.$fields['Author:'].'</td></tr>
                                                <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.note',1).'</td><td class="bgColor4">'.$fields['Note:'].'</td></tr>
                                        </table>
                                ';
                        }
                }
                return $out;
        }








        /******************************
         *
         * Various helper functions
         *
         ******************************/

        function setDispFields()        {

                        // Getting from session:
                $dispFields = $GLOBALS['BE_USER']->getModuleData('db_list.php/displayFields');

                        // If fields has been inputted, then set those as the value and push it to session variable:
                if (is_array($this->displayFields))     {
                        reset($this->displayFields);
                        $tKey = key($this->displayFields);
                        $dispFields[$tKey]=$this->displayFields[$tKey];
                        $GLOBALS['BE_USER']->pushModuleData('db_list.php/displayFields',$dispFields);
                }

                        // Setting result:
                $this->setFields=$dispFields;
        }

        function thumbCode($row,$table,$field)  {
                return t3lib_BEfunc::thumbCode($row,$table,$field,$this->backPath,$this->thumbScript);
        }

        function makeQueryArray($table, $id, $addWhere="",$fieldList='*')       {
                global $TCA;

                        // Set ORDER BY:
                $orderBy = ($TCA[$table]['ctrl']['sortby']) ? 'ORDER BY '.$TCA[$table]['ctrl']['sortby'] : $TCA[$table]['ctrl']['default_sortby'];
                if ($this->sortField)   {
                        if (in_array($this->sortField,$this->makeFieldList($table,1)))  {
                                $orderBy = 'ORDER BY '.$this->sortField;
                                if ($this->sortRev)     $orderBy.=' DESC';
                        }
                }

                        // Set LIMIT:
                $limit = $this->iLimit ? ($this->firstElementNumber ? $this->firstElementNumber.',' : '').($this->iLimit+1) : '';

                        // Filtering on displayable pages (permissions):
                $pC = ($table=='pages' && $this->perms_clause)?' AND '.$this->perms_clause:'';

                        // Adding search constraints:
                $search = $this->makeSearchString($table);

                        // Compiling query array:
                $queryParts = array(
                        'SELECT' => $fieldList,
                        'FROM' => $table,
                        'WHERE' => $this->pidSelect.' '.$pC.t3lib_BEfunc::deleteClause($table).' '.$addWhere.' '.$search,
                        'GROUPBY' => '',
                        'ORDERBY' => $GLOBALS['TYPO3_DB']->stripOrderBy($orderBy),
                        'LIMIT' => $limit
                );

                        // Return query:
                return $queryParts;
        }

        function setTotalItems($queryParts)     {
                $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                        'count(*)',
                                        $queryParts['FROM'],
                                        $queryParts['WHERE']
                                );
                list($rCount) = $GLOBALS['TYPO3_DB']->sql_fetch_row($result);
                $this->totalItems = $rCount;
        }

        function makeSearchString($table)       {
                global $TCA;

                        // Make query, only if table is valid and a search string is actually defined:
                if ($TCA[$table] && $this->searchString)        {

                                // Loading full table description - we need to traverse fields:
                        t3lib_div::loadTCA($table);

                                // Initialize field array:
                        $sfields=array();
                        $sfields[]='uid';       // Adding "uid" by default.

                                // Traverse the configured columns and add all columns that can be searched:
                        foreach($TCA[$table]['columns'] as $fieldName => $info) {
                                if ($info['config']['type']=='text' || ($info['config']['type']=='input' && !ereg('date|time|int',$info['config']['eval'])))    {
                                        $sfields[]=$fieldName;
                                }
                        }

                                // If search-fields were defined (and there always are) we create the query:
                        if (count($sfields))    {
                                $like = ' LIKE \'%'.$GLOBALS['TYPO3_DB']->quoteStr($this->searchString, $table).'%\'';          // Free-text searching...
                                $queryPart = ' AND ('.implode($like.' OR ',$sfields).$like.')';

                                        // Return query:
                                return $queryPart;
                        }
                }
        }

        function linkWrapTable($table,$code)    {
                if ($this->table!=$table)       {
                        return '<a href="'.htmlspecialchars($this->listURL('',$table)).'">'.$code.'</a>';
                } else {
                        return '<a href="'.htmlspecialchars($this->listURL('','','sortField,sortRev,table')).'">'.$code.'</a>';
                }
        }

        function linkWrapItems($table,$uid,$code,$row)  {
                global $TCA, $LANG;

                        // If the title is blank, make a "no title" label:
                if (!strcmp($code,'')) {
                        $code = '<i>['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title',1).']</i> - '.htmlspecialchars(t3lib_div::fixed_lgd_cs(t3lib_BEfunc::getRecordTitle($table,$row),$GLOBALS['BE_USER']->uc['titleLen']));
                } else {
                        $code = htmlspecialchars(t3lib_div::fixed_lgd_cs($code,$this->fixedL));
                }

                switch((string)$this->clickTitleMode)   {
                        case 'edit':
                                        // If the listed table is 'pages' we have to request the permission settings for each page:
                                if ($table=='pages')    {
                                        $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(t3lib_BEfunc::getRecord('pages',$row['uid']));
                                        $permsEdit = $localCalcPerms&2;
                                } else {
                                        $permsEdit = $this->calcPerms&16;
                                }

                                        // "Edit" link: ( Only if permissions to edit the page-record of the content of the parent page ($this->id)
                                if ($permsEdit) {
                                        $params='&edit['.$table.']['.$row['uid'].']=edit';
                                        $code = '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::editOnClick($params,'',-1)).'" title="'.$LANG->getLL('edit',1).'">'.
                                                        $code.
                                                        '</a>';
                                }
                        break;
                        case 'show':
                                        // "Show" link (only pages and tt_content elements)
                                if ($table=='pages' || $table=='tt_content')    {
                                        $code = '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($table=='tt_content'?$this->id.'#'.$row['uid']:$row['uid'])).'" title="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:labels.showPage',1).'">'.
                                                        $code.
                                                        '</a>';
                                }
                        break;
                        case 'info':
                                // "Info": (All records)
                                $code = '<a href="#" onclick="'.htmlspecialchars('top.launchView(\''.$table.'\', \''.$row['uid'].'\'); return false;').'" title="'.$LANG->getLL('showInfo',1).'">'.
                                        $code.
                                        '</a>';
                        break;
                        default:
                                        // Output the label now:
                                if ($table=='pages')    {
                                        $code = '<a href="'.htmlspecialchars($this->listURL($uid,'')).'">'.$code.'</a>';
                                }
                        break;
                }

                return $code;
        }

        function listURL($altId='',$table=-1,$exclList='')      {
                return $this->script.
                        '?id='.(strcmp($altId,'')?$altId:$this->id).
                        '&table='.rawurlencode($table==-1?$this->table:$table).
                        ($this->thumbs?'&imagemode='.$this->thumbs:'').
                        ($this->returnUrl?'&returnUrl='.rawurlencode($this->returnUrl):'').
                        ($this->searchString?'&search_field='.rawurlencode($this->searchString):'').
                        ($this->searchLevels?'&search_levels='.rawurlencode($this->searchLevels):'').
                        ($this->showLimit?'&showLimit='.rawurlencode($this->showLimit):'').
                        ((!$exclList || !t3lib_div::inList($exclList,'sortField')) && $this->sortField?'&sortField='.rawurlencode($this->sortField):'').
                        ((!$exclList || !t3lib_div::inList($exclList,'sortRev')) && $this->sortRev?'&sortRev='.rawurlencode($this->sortRev):'')
                        ;
        }

        function requestUri()   {
                return $this->listURL();
        }

        function makeFieldList($table,$dontCheckUser=0) {
                global $TCA,$BE_USER;

                        // Init fieldlist array:
                $fieldListArr = array();

                        // Check table:
                if (is_array($TCA[$table]))     {
                        t3lib_div::loadTCA($table);

                                // Traverse configured columns and add them to field array, if available for user.
                        foreach($TCA[$table]['columns'] as $fN => $fieldValue)  {
                                if ($dontCheckUser ||
                                        ((!$fieldValue['exclude'] || $BE_USER->check('non_exclude_fields',$table.':'.$fN)) && $fieldValue['config']['type']!='passthrough'))    {
                                        $fieldListArr[]=$fN;
                                }
                        }

                                // Add special fields:
                        if ($dontCheckUser || $BE_USER->isAdmin())      {
                                $fieldListArr[]='uid';
                                $fieldListArr[]='pid';
                                if ($TCA[$table]['ctrl']['tstamp'])     $fieldListArr[]=$TCA[$table]['ctrl']['tstamp'];
                                if ($TCA[$table]['ctrl']['crdate'])     $fieldListArr[]=$TCA[$table]['ctrl']['crdate'];
                                if ($TCA[$table]['ctrl']['cruser_id'])  $fieldListArr[]=$TCA[$table]['ctrl']['cruser_id'];
                                if ($TCA[$table]['ctrl']['sortby'])     $fieldListArr[]=$TCA[$table]['ctrl']['sortby'];
                                if ($TCA[$table]['ctrl']['versioning']) $fieldListArr[]='t3ver_id';
                        }
                }
                return $fieldListArr;
        }

        function getTreeObject($id,$depth,$perms_clause)        {
                $tree = t3lib_div::makeInstance('t3lib_pageTree');
                $tree->init('AND '.$perms_clause);
                $tree->makeHTML=0;
                $tree->fieldArray = Array('uid','php_tree_stop');
                if ($depth)     {
                        $tree->getTree($id, $depth, '');
                }
                $tree->ids[]=$id;
                return $tree;
        }
}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.db_list.inc']) {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.db_list.inc']);
}
?>

---