AbstractRecordList.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\RecordList;

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\Utility\IconUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class AbstractRecordList {

    // Used in this class:
    // default Max items shown
    public $iLimit = 10;

    // OBSOLETE - NOT USED ANYMORE. leftMargin
    public $leftMargin = 0;

    public $showIcon = 1;

    public $no_noWrap = 0;

    // If set this is <td> CSS-classname for odd columns in addElement. Used with db_layout / pages section
    public $oddColumnsCssClass = '';

    public $backPath = '';

    // Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.
    public $fieldArray = array();

    // Keys are fieldnames and values are td-parameters to add in addElement(), please use $addElement_tdCSSClass for CSS-classes;
    public $addElement_tdParams = array();

    // Keys are fieldnames and values are td-css-classes to add in addElement();
    public $addElement_tdCssClass = array();

    // Not used in this class - but maybe extension classes...
    // Max length of strings
    public $fixedL = 30;

    public $thisScript = '';

    // Set to zero, if you don't want a left-margin with addElement function
    public $setLMargin = 1;

    // Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard
    public $counter = 0;

    // This could be set to the total number of items. Used by the fwd_rew_navigation...
    public $totalItems = '';

    // Internal (used in this class.)
    public $firstElementNumber = 0;

    public $eCounter = 0;

    // String with accumulated HTML content
    public $HTMLcode = '';

    // Contains page translation languages
    public $pageOverlays = array();

    // Contains sys language icons and titles
    public $languageIconTitles = array();

    public $translateTools;

    public function __construct() {
        if (isset($GLOBALS['BE_USER']->uc['titleLen']) && $GLOBALS['BE_USER']->uc['titleLen'] > 0) {
            $this->fixedL = $GLOBALS['BE_USER']->uc['titleLen'];
        }
        $this->getTranslateTools();
    }

    protected function determineScriptUrl() {
        if ($moduleName = \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('M')) {
            $this->thisScript = \TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl($moduleName);
        } else {
            $this->thisScript = \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('SCRIPT_NAME');
        }
    }

    protected function getThisScript() {
        return strpos($this->thisScript, '?') === FALSE ? $this->thisScript . '?' : $this->thisScript . '&';
    }

    public function addElement($h, $icon, $data, $trParams = '', $lMargin = '', $altLine = '') {
        $noWrap = $this->no_noWrap ? '' : ' nowrap="nowrap"';
        // Start up:
        $out = '
        <!-- Element, begin: -->
        <tr ' . $trParams . '>';
        // Show icon and lines
        if ($this->showIcon) {
            $out .= '
            <td nowrap="nowrap" class="col-icon">';
            if (!$h) {
                $out .= '<img src="clear.gif" width="1" height="8" alt="" />';
            } else {
                for ($a = 0; $a < $h; $a++) {
                    if (!$a) {
                        if ($icon) {
                            $out .= $icon;
                        }
                    } else {

                    }
                }
            }
            $out .= '</td>
            ';
        }
        // Init rendering.
        $colsp = '';
        $lastKey = '';
        $c = 0;
        $ccount = 0;
        // Traverse field array which contains the data to present:
        foreach ($this->fieldArray as $vKey) {
            if (isset($data[$vKey])) {
                if ($lastKey) {
                    $cssClass = $this->addElement_tdCssClass[$lastKey];
                    if ($this->oddColumnsCssClass && $ccount % 2 == 0) {
                        $cssClass = implode(' ', array($this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass));
                    }
                    $out .= '
                        <td' . $noWrap . ' class="' . $cssClass . '"' . $colsp . $this->addElement_tdParams[$lastKey] . '>' . $data[$lastKey] . '</td>';
                }
                $lastKey = $vKey;
                $c = 1;
                $ccount++;
            } else {
                if (!$lastKey) {
                    $lastKey = $vKey;
                }
                $c++;
            }
            if ($c > 1) {
                $colsp = ' colspan="' . $c . '"';
            } else {
                $colsp = '';
            }
        }
        if ($lastKey) {
            $cssClass = $this->addElement_tdCssClass[$lastKey];
            if ($this->oddColumnsCssClass) {
                $cssClass = implode(' ', array($this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass));
            }
            $out .= '
                <td' . $noWrap . ' class="' . $cssClass . '"' . $colsp . $this->addElement_tdParams[$lastKey] . '>' . $data[$lastKey] . '</td>';
        }
        // End row
        $out .= '
        </tr>';
        // Return row.
        return $out;
    }

    public function writeTop() {

    }

    public function writeBottom() {
        GeneralUtility::logDeprecatedFunction();
    }

    public function fwd_rwd_nav($table = '') {
        $code = '';
        if ($this->eCounter >= $this->firstElementNumber && $this->eCounter < $this->firstElementNumber + $this->iLimit) {
            if ($this->firstElementNumber && $this->eCounter == $this->firstElementNumber) {
                //  Reverse
                $theData = array();
                $titleCol = $this->fieldArray[0];
                $theData[$titleCol] = $this->fwd_rwd_HTML('fwd', $this->eCounter, $table);
                $code = $this->addElement(1, '', $theData, 'class="fwd_rwd_nav"');
            }
            return array(1, $code);
        } else {
            if ($this->eCounter == $this->firstElementNumber + $this->iLimit) {
                //  Forward
                $theData = array();
                $titleCol = $this->fieldArray[0];
                $theData[$titleCol] = $this->fwd_rwd_HTML('rwd', $this->eCounter, $table);
                $code = $this->addElement(1, '', $theData, 'class="fwd_rwd_nav"');
            }
            return array(0, $code);
        }
    }

    public function fwd_rwd_HTML($type, $pointer, $table = '') {
        $content = '';
        $tParam = $table ? '&table=' . rawurlencode($table) : '';
        switch ($type) {
            case 'fwd':
                $href = $this->listURL() . '&pointer=' . ($pointer - $this->iLimit) . $tParam;
                $content = '<a href="' . htmlspecialchars($href) . '">' . IconUtility::getSpriteIcon('actions-move-up') . '</a> <i>[1 - ' . $pointer . ']</i>';
                break;
            case 'rwd':
                $href = $this->listURL() . '&pointer=' . $pointer . $tParam;
                $content = '<a href="' . htmlspecialchars($href) . '">' . IconUtility::getSpriteIcon('actions-move-down') . '</a> <i>[' . ($pointer + 1) . ' - ' . $this->totalItems . ']</i>';
                break;
        }
        return $content;
    }

    public function listURL($altId = '') {
        return $this->getThisScript() . 'id=' . ($altId !== '' ? $altId : $this->id);
    }

    public function CBfunctions() {
        return '
        // checkOffCB()
    function checkOffCB(listOfCBnames, link) {  //
        var checkBoxes, flag, i;
        var checkBoxes = listOfCBnames.split(",");
        if (link.rel === "") {
            link.rel = "allChecked";
            flag = true;
        } else {
            link.rel = "";
            flag = false;
        }
        for (i = 0; i < checkBoxes.length; i++) {
            setcbValue(checkBoxes[i], flag);
        }
    }
        // cbValue()
    function cbValue(CBname) {  //
        var CBfullName = "CBC["+CBname+"]";
        return (document.dblistForm[CBfullName] && document.dblistForm[CBfullName].checked ? 1 : 0);
    }
        // setcbValue()
    function setcbValue(CBname,flag) {  //
        CBfullName = "CBC["+CBname+"]";
        if(document.dblistForm[CBfullName]) {
            document.dblistForm[CBfullName].checked = flag ? "on" : 0;
        }
    }

        ';
    }

    public function initializeLanguages() {
        // Look up page overlays:
        $this->pageOverlays = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('*', 'pages_language_overlay', 'pid=' . (int)$this->id . BackendUtility::deleteClause('pages_language_overlay') . BackendUtility::versioningPlaceholderClause('pages_language_overlay'), '', '', '', 'sys_language_uid');
        $this->languageIconTitles = $this->getTranslateTools()->getSystemLanguages($this->id, $this->backPath);
    }

    public function languageFlag($sys_language_uid, $addAsAdditionalText = TRUE) {
        $out = '';
        $title = htmlspecialchars($this->languageIconTitles[$sys_language_uid]['title']);
        if ($this->languageIconTitles[$sys_language_uid]['flagIcon']) {
            $out .= IconUtility::getSpriteIcon($this->languageIconTitles[$sys_language_uid]['flagIcon'], array('title' => $title));
            if (!$addAsAdditionalText) {
                return $out;
            }
            $out .= '&nbsp;';
        }
        $out .= $title;
        return $out;
    }

    protected function getTranslateTools() {
        if (!isset($this->translateTools)) {
            $this->translateTools = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Configuration\\TranslationConfigurationProvider');
        }
        return $this->translateTools;
    }

    protected function generateReferenceToolTip(array $references, $launchViewParameter = '') {
        $result = array();
        foreach ($references as $reference) {
            $result[] = $reference['tablename'] . ':' . $reference['recuid'] . ':' . $reference['field'];
            if (strlen(implode(' / ', $result)) >= 100) {
                break;
            }
        }
        if (empty($result)) {
            $htmlCode = '-';
        } else {
            $htmlCode = '<a href="#"';
            if ($launchViewParameter !== '') {
                $htmlCode .= ' onclick="' . htmlspecialchars(('top.launchView(' . $launchViewParameter . '); return false;')) . '"';
            }
            $htmlCode .= ' title="' . htmlspecialchars(GeneralUtility::fixed_lgd_cs(implode(' / ', $result), 100)) . '">';
            $htmlCode .= count($references);
            $htmlCode .= '</a>';
        }
        return $htmlCode;
    }

}