Your IP : 216.73.216.43
<?php
declare(strict_types=1);
/*
* 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!
*/
namespace TYPO3\CMS\Fluid\ViewHelpers\Be;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Module\ModuleData;
use TYPO3\CMS\Backend\RecordList\DatabaseRecordList;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use TYPO3\CMS\Fluid\Core\Rendering\RenderingContext;
/**
* ViewHelper which renders a record list as known from the TYPO3 list module.
*
* .. note::
* This feature is experimental!
*
* Examples
* ========
*
* Minimal::
*
* <f:be.tableList tableName="fe_users" />
*
* List of all "Website user" records stored in the configured storage PID.
* Records will be editable, if the current backend user has got edit rights for the table ``fe_users``.
*
* Only the title column (username) will be shown.
*
* Context menu is active.
*
* Full::
*
* <f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}"
* storagePid="1"
* levels="2"
* filter="foo"
* recordsPerPage="10"
* sortField="name"
* sortDescending="true"
* readOnly="true"
* enableClickMenu="false"
* enableControlPanels="true"
* clickTitleMode="info"
* />
*
* List of "Website user" records with a text property of ``foo`` stored on PID ``1`` and two levels down.
* Clicking on a username will open the TYPO3 info popup for the respective record
*/
final class TableListViewHelper extends AbstractBackendViewHelper
{
/**
* As this ViewHelper renders HTML, the output must not be escaped.
*
* @var bool
*/
protected $escapeOutput = false;
protected ConfigurationManagerInterface $configurationManager;
public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager): void
{
$this->configurationManager = $configurationManager;
}
public function initializeArguments(): void
{
parent::initializeArguments();
$this->registerArgument('tableName', 'string', 'name of the database table', true);
$this->registerArgument('fieldList', 'array', 'list of fields to be displayed. If empty, only the title column (configured in $TCA[$tableName][\'ctrl\'][\'title\']) is shown', false, []);
$this->registerArgument('storagePid', 'int', 'by default, records are fetched from the storage PID configured in persistence.storagePid. With this argument, the storage PID can be overwritten');
$this->registerArgument('levels', 'int', 'corresponds to the level selector of the TYPO3 list module. By default only records from the current storagePid are fetched', false, 0);
$this->registerArgument('filter', 'string', 'corresponds to the "Search String" textbox of the TYPO3 list module. If not empty, only records matching the string will be fetched', false, '');
$this->registerArgument('recordsPerPage', 'int', 'amount of records to be displayed at once. Defaults to $TCA[$tableName][\'interface\'][\'maxSingleDBListItems\'] or (if that\'s not set) to 100', false, 0);
$this->registerArgument('sortField', 'string', 'table field to sort the results by', false, '');
$this->registerArgument('sortDescending', 'bool', 'if TRUE records will be sorted in descending order', false, false);
$this->registerArgument('readOnly', 'bool', 'if TRUE, the edit icons won\'t be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table!', false, false);
$this->registerArgument('enableClickMenu', 'bool', 'enables context menu', false, true);
$this->registerArgument('enableControlPanels', 'bool', 'enables control panels', false, false);
$this->registerArgument('clickTitleMode', 'string', 'one of "edit", "show" (only pages, tt_content), "info', false, '');
}
/**
* Renders a record list as known from the TYPO3 list module
* Note: This feature is experimental!
*
* @see \TYPO3\CMS\Backend\RecordList\DatabaseRecordList
*/
public function render(): string
{
$tableName = $this->arguments['tableName'];
$fieldList = $this->arguments['fieldList'];
$storagePid = $this->arguments['storagePid'];
$levels = $this->arguments['levels'];
$filter = $this->arguments['filter'];
$recordsPerPage = $this->arguments['recordsPerPage'];
$sortField = $this->arguments['sortField'];
$sortDescending = $this->arguments['sortDescending'];
$readOnly = $this->arguments['readOnly'];
$enableClickMenu = $this->arguments['enableClickMenu'];
$clickTitleMode = $this->arguments['clickTitleMode'];
$enableControlPanels = $this->arguments['enableControlPanels'];
$languageService = $this->getLanguageService();
$backendUser = $this->getBackendUser();
/** @var RenderingContext $renderingContext */
$renderingContext = $this->renderingContext;
$request = $renderingContext->getRequest();
if (!$request instanceof ServerRequestInterface) {
// All views in backend have at least ServerRequestInterface, no matter if created by
// old StandaloneView via BackendViewFactory. Should be fine to assume having a request
// here, the early return is just sanitation.
return '';
}
$this->getPageRenderer()->loadJavaScriptModule('@typo3/backend/recordlist.js');
$this->getPageRenderer()->loadJavaScriptModule('@typo3/backend/record-download-button.js');
$this->getPageRenderer()->loadJavaScriptModule('@typo3/backend/action-dispatcher.js');
if ($enableControlPanels === true) {
$this->getPageRenderer()->loadJavaScriptModule('@typo3/backend/multi-record-selection.js');
$this->getPageRenderer()->loadJavaScriptModule('@typo3/backend/context-menu.js');
}
$pageId = (int)($request->getParsedBody()['id'] ?? $request->getQueryParams()['id'] ?? 0);
$pointer = (int)($request->getParsedBody()['pointer'] ?? $request->getQueryParams()['pointer'] ?? 0);
$pageInfo = BackendUtility::readPageAccess($pageId, $backendUser->getPagePermsClause(Permission::PAGE_SHOW)) ?: [];
$existingModuleData = $backendUser->getModuleData('web_list');
$moduleData = new ModuleData('web_list', is_array($existingModuleData) ? $existingModuleData : []);
$dbList = GeneralUtility::makeInstance(DatabaseRecordList::class);
$dbList->setRequest($request);
$dbList->setModuleData($moduleData);
$dbList->pageRow = $pageInfo;
if ($readOnly) {
$dbList->setIsEditable(false);
} else {
$dbList->calcPerms = new Permission($backendUser->calcPerms($pageInfo));
}
$dbList->disableSingleTableView = true;
$dbList->clickTitleMode = $clickTitleMode;
$dbList->clickMenuEnabled = $enableClickMenu;
if ($storagePid === null) {
$frameworkConfiguration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
$storagePid = $frameworkConfiguration['persistence']['storagePid'];
}
$dbList->start($storagePid, $tableName, $pointer, $filter, $levels, $recordsPerPage);
// Column selector is disabled since fields are defined by the "fieldList" argument
$dbList->displayColumnSelector = false;
$dbList->setFields = [$tableName => $fieldList];
$dbList->noControlPanels = !$enableControlPanels;
$dbList->sortField = $sortField;
$dbList->sortRev = $sortDescending;
return $dbList->generateList();
}
protected function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
protected function getLanguageService(): LanguageService
{
return $GLOBALS['LANG'];
}
}