9.5/_abstract_record_list_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\RecordList;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\BackendWorkspaceRestriction;

use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


abstract class ‪AbstractRecordList

{

    protected ‪$id = 0;


    public ‪$iLimit = 10;


    public ‪$leftMargin = 0;


    public ‪$showIcon = 1;


    public ‪$no_noWrap = 0;


    public ‪$oddColumnsCssClass = '';


    public ‪$fieldArray = [];


    public ‪$addElement_tdParams = [];


    public ‪$addElement_tdCssClass = [];


    public ‪$fixedL = 30;


    public ‪$thisScript = '';


    public ‪$setLMargin = 1;


    public ‪$counter = 0;


    public ‪$totalItems = '';


    public ‪$firstElementNumber = 0;


    public ‪$eCounter = 0;


    public ‪$HTMLcode = '';


    public ‪$pageOverlays = [];


    public ‪$languageIconTitles = [];


    public ‪$translateTools;


    protected ‪$iconFactory;


    public function ‪__construct()

    {

        trigger_error('The class AbstractRecordList will be removed in TYPO3 v10.0, as all logic was moved into specific classes that inherited from AbstractRecordList.', E_USER_DEPRECATED);

        if (isset(‪$GLOBALS['BE_USER']->uc['titleLen']) && ‪$GLOBALS['BE_USER']->uc['titleLen'] > 0) {

            $this->fixedL = ‪$GLOBALS['BE_USER']->uc['titleLen'];

        }

        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);

        $this->‪getTranslateTools();

        $this->‪determineScriptUrl();

    }


    protected function ‪determineScriptUrl()

    {

        if ($routePath = GeneralUtility::_GP('route')) {

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $this->thisScript = (string)$uriBuilder->buildUriFromRoutePath($routePath);

        } else {

            $this->thisScript = GeneralUtility::getIndpEnv('SCRIPT_NAME');

        }

    }


    protected function ‪getThisScript()

    {

        return strpos($this->thisScript, '?') === false ? $this->thisScript . '?' : $this->thisScript . '&';

    }


    public function ‪addElement($h, $icon, $data, $rowParams = '', $_ = '', $_2 = '', $colType = 'td')

    {

        $colType = ($colType === 'th') ? 'th' : 'td';

        $noWrap = $this->no_noWrap ? '' : ' nowrap';

        // Start up:

        $l10nParent = isset($data['_l10nparent_']) ? (int)$data['_l10nparent_'] : 0;

        $out = '

        <!-- Element, begin: -->

        <tr ' . $rowParams . ' data-uid="' . (int)$data['uid'] . '" data-l10nparent="' . $l10nParent . '">';

        // Show icon and lines

        if ($this->showIcon) {

            $out .= '

            <' . $colType . ' class="col-icon nowrap">';

            if (!$h) {

                $out .= '&nbsp;';

            } else {

                for ($a = 0; $a < $h; $a++) {

                    if (!$a) {

                        if ($icon) {

                            $out .= $icon;

                        }

                    }

                }

            }

            $out .= '</' . $colType . '>

            ';

        }

        // Init rendering.

        $colsp = '';

        $lastKey = '';

        $c = 0;

        $ccount = 0;

        // __label is used as the label key to circumvent problems with uid used as label (see #67756)

        // as it was introduced later on, check if it really exists before using it

        ‪$fields = ‪$this->fieldArray;

        if ($colType === 'td' && array_key_exists('__label', $data)) {

            ‪$fields[0] = '__label';

        }

        // Traverse field array which contains the data to present:

        foreach (‪$fields as $vKey) {

            if (isset($data[$vKey])) {

                if ($lastKey) {

                    $cssClass = $this->addElement_tdCssClass[$lastKey];

                    if ($this->oddColumnsCssClass && $ccount % 2 == 0) {

                        $cssClass = implode(' ', [$this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass]);

                    }

                    $out .= '

                        <' . $colType . ' class="' . $cssClass . $noWrap . '"' . $colsp . $this->addElement_tdParams[$lastKey] . '>' . $data[$lastKey] . '</' . $colType . '>';

                }

                $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(' ', [$this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass]);

            }

            $out .= '

                <' . $colType . ' class="' . $cssClass . $noWrap . '"' . $colsp . $this->addElement_tdParams[$lastKey] . '>' . $data[$lastKey] . '</' . $colType . '>';

        }

        // End row

        $out .= '

        </tr>';

        // Return row.

        return $out;

    }


    public function ‪writeTop()

    {

    }


    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 = [];

                $titleCol = $this->fieldArray[0];

                $theData[$titleCol] = $this->‪fwd_rwd_HTML('fwd', $this->eCounter, $table);

                $code = $this->‪addElement(1, '', $theData, 'class="fwd_rwd_nav"');

            }

            return [1, $code];

        }

        if ($this->eCounter == $this->firstElementNumber + $this->iLimit) {

            //  Forward

            $theData = [];

            $titleCol = $this->fieldArray[0];

            $theData[$titleCol] = $this->‪fwd_rwd_HTML('rwd', $this->eCounter, $table);

            $code = $this->‪addElement(1, '', $theData, 'class="fwd_rwd_nav"');

        }

        return [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) . '">' . $this->iconFactory->getIcon('actions-move-up', ‪Icon::SIZE_SMALL)->render() . '</a> <i>[' . (max(0, $pointer - $this->iLimit) + 1) . ' - ' . $pointer . ']</i>';

                break;

            case 'rwd':

                $href = $this->‪listURL() . '&pointer=' . $pointer . $tParam;

                $content = '<a href="' . htmlspecialchars($href) . '">' . $this->iconFactory->getIcon('actions-move-down', ‪Icon::SIZE_SMALL)->render() . '</a> <i>[' . ($pointer + 1) . ' - ' . $this->totalItems . ']</i>';

                break;

        }

        return $content;

    }


    public function ‪listURL($altId = '', $table = '-1', $exclList = '')

    {

        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:

        $localizationParentField = ‪$GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'];

        $languageField = ‪$GLOBALS['TCA']['pages']['ctrl']['languageField'];

        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)

            ->getQueryBuilderForTable('pages');

        $queryBuilder->getRestrictions()

            ->removeAll()

            ->add(GeneralUtility::makeInstance(DeletedRestriction::class))

            ->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));

        $result = $queryBuilder

            ->select('*')

            ->from('pages')

            ->where(

                $queryBuilder->expr()->andX(

                    $queryBuilder->expr()->eq($localizationParentField, $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)),

                    $queryBuilder->expr()->gt($languageField, $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT))

                )

            )

            ->execute();


        $this->pageOverlays = [];

        while ($row = $result->fetch()) {

            $this->pageOverlays[$row[$languageField]] = $row;

        }


        $this->languageIconTitles = $this->‪getTranslateTools()->‪getSystemLanguages($this->id);

    }


    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 .= '<span title="' . $title . '">' . $this->iconFactory->getIcon($this->languageIconTitles[$sys_language_uid]['flagIcon'], ‪Icon::SIZE_SMALL)->render() . '</span>';

            if (!$addAsAdditionalText) {

                return $out;

            }

            $out .= '&nbsp;';

        }

        $out .= $title;

        return $out;

    }


    protected function ‪getTranslateTools()

    {

        if (!isset($this->translateTools)) {

            $this->translateTools = GeneralUtility::makeInstance(TranslationConfigurationProvider::class);

        }

        return ‪$this->translateTools;

    }


    protected function ‪generateReferenceToolTip($references, $launchViewParameter = '')

    {

        if (!$references) {

            $htmlCode = '-';

        } else {

            $htmlCode = '<a href="#"';

            if ($launchViewParameter !== '') {

                $htmlCode .= ' onclick="' . htmlspecialchars('top.TYPO3.InfoWindow.showItem(' . $launchViewParameter . '); return false;') . '"';

            }

            $htmlCode .= ' title="' . htmlspecialchars($this->‪getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang.xlf:show_references') . ' (' . $references . ')') . '">';

            $htmlCode .= $references;

            $htmlCode .= '</a>';

        }

        return $htmlCode;

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }

}