Your IP : 216.73.216.43
<?php
/*
* 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\Backend\RecordList;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Clipboard\Clipboard;
use TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider;
use TYPO3\CMS\Backend\Module\ModuleData;
use TYPO3\CMS\Backend\Module\ModuleProvider;
use TYPO3\CMS\Backend\RecordList\Event\ModifyRecordListHeaderColumnsEvent;
use TYPO3\CMS\Backend\RecordList\Event\ModifyRecordListRecordActionsEvent;
use TYPO3\CMS\Backend\RecordList\Event\ModifyRecordListTableActionsEvent;
use TYPO3\CMS\Backend\Routing\PreviewUriBuilder;
use TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface;
use TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton;
use TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\View\BackendViewFactory;
use TYPO3\CMS\Backend\View\Event\ModifyDatabaseQueryForRecordListingEvent;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use TYPO3\CMS\Core\Database\ReferenceIndex;
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\LinkHandling\Exception\UnknownLinkHandlerException;
use TYPO3\CMS\Core\LinkHandling\LinkService;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\Service\DependencyOrderingService;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Core\Versioning\VersionState;
/**
* Class for rendering of Web>List module
* @internal This class is a specific TYPO3 Backend implementation and is not part of the TYPO3's Core API.
*/
class DatabaseRecordList
{
// *********
// External:
// *********
/**
* Used to indicate which tables (values in the array) that can have a
* create-new-record link. If the array is empty, all tables are allowed.
*
* @var string[]
*/
public $allowedNewTables = [];
/**
* Used to indicate which tables (values in the array) that cannot have a
* create-new-record link. If the array is empty, all tables are allowed.
*
* @var string[]
*/
public $deniedNewTables = [];
/**
* If TRUE, will show the clipboard related actions in the table header.
*
* @var bool
*/
public $showClipboardActions = false;
/**
* If TRUE, will DISABLE all control panels in lists. (Takes precedence)
*
* @var bool
*/
public $noControlPanels = false;
/**
* If TRUE, clickmenus will be rendered
*
* @var bool
*/
public $clickMenuEnabled = true;
/**
* Space icon used for alignment
*/
protected string $spaceIcon;
/**
* Disable single table view
*
* @var bool
*/
public $disableSingleTableView = false;
// *********
// Internal:
// *********
/**
* Set to the page record (see writeTop())
*
* @var string[]
*/
public $pageRow = [];
/**
* Tables which should not list their translations
*
* @var string
*/
public string $hideTranslations = '';
/**
* Cache for record path
*
* @var mixed[]
*/
protected array $recPath_cache = [];
/**
* Field, to sort list by
*/
public string $sortField = '';
/**
* Data of the module from the user's session
*/
protected ?ModuleData $moduleData = null;
/**
* Page id
*
* @var int
*/
public $id;
/**
* Used for tracking duplicate values of fields
*
* @var string[]
*/
protected array $duplicateStack = [];
/**
* If TRUE, records are listed only if a specific table is selected.
*
* @var bool
*/
public $listOnlyInSingleTableMode = false;
/**
* @var array[] Module configuration
*/
public $modTSconfig;
/**
* Keys are fieldnames and values are td-css-classes to add in addElement();
*/
protected array $addElement_tdCssClass = [];
/**
* Used for tracking next/prev uids
*
* @var int[][]
*/
public $currentTable = [];
/**
* Number of records to show
*/
public int $showLimit = 0;
/**
* Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.
*
* @var array
*/
public $fieldArray = [];
/**
* Tables which should not get listed
*
* @var string
*/
public $hideTables = '';
/**
* Page select permissions
*
* @var string
*/
public $perms_clause = '';
/**
* Return URL
*
* @var string
*/
public $returnUrl = '';
/**
* Tablename if single-table mode
*
* @var string
*/
public $table = '';
/**
* Some permissions...
*
* @var Permission
*/
public $calcPerms;
/**
* Mode for what happens when a user clicks the title of a record.
*
* @var string
*/
public $clickTitleMode = '';
/**
* Levels to search down.
*/
protected int $searchLevels = 0;
/**
* TSconfig which overwrites TCA-Settings
*
* @var string[][]
*/
public array $tableTSconfigOverTCA = [];
/**
* Fields to display for the current table
*
* @var string[][]
*/
public array $setFields = [];
/**
* Paging for the single table view
*
* @var int
*/
protected $page = 0;
/**
* Search string
*
* @var string
*/
public $searchString = '';
/**
* Field, indicating to sort in reverse order.
*
* @var bool
*/
public bool $sortRev = false;
/**
* String, can contain the field name from a table which must have duplicate values marked.
*/
protected string $duplicateField = '';
/**
* Specify a list of tables which are the only ones allowed to be displayed.
*
* @var string
*/
public $tableList = '';
/**
* Clipboard object
*
* @var Clipboard
*/
public $clipObj;
/**
* Tracking names of elements (for clipboard use)
*
* @var string[]
*/
public $CBnames = [];
/**
* Whether the column selector should be displayed in the tables' header
*
* @internal
*/
public bool $displayColumnSelector = true;
/**
* Whether the record download should be displayed in the tables' header
*
* @internal
*/
public bool $displayRecordDownload = true;
/**
* [$tablename][$uid] = number of references to this record
*
* @var int[][]
*/
protected array $referenceCount = [];
/**
* If defined the records are editable
*/
protected bool $editable = true;
/**
* Array with before/after setting for tables
* Structure:
* 'tableName' => [
* 'before' => ['A', ...]
* 'after' => []
* ]
*
* @var array[]
*/
protected array $tableDisplayOrder = [];
/**
* Override the page ids taken into account by getPageIdConstraint()
*/
protected array $overridePageIdList = [];
/**
* Override/add urlparameters in listUrl() method
* @var mixed[]
*/
protected array $overrideUrlParameters = [];
/**
* Current link: array with table names and uid
*/
protected array $currentLink = [];
/**
* Only used to render translated records, used in list module to show page translations
*/
protected bool $showOnlyTranslatedRecords = false;
/**
* This array contains all possible language uids, which could be translations of a record (excluding pages) in the default language
*
* It mainly depends on the current pageUid.
* Translations are possible, depending on
* - the site config
* - already translated page records
*
* @var int[]
*/
protected array $possibleTranslations = [];
/**
* All languages that are allowed by the user
*
* This is used for the translation handling of pages only.
*/
protected array $languagesAllowedForUser = [];
/**
* A runtime first-level cache to avoid unneeded calls to BackendUtility::getRecord()
*/
protected array $pagePermsCache = [];
protected array $showLocalizeColumn = [];
protected ServerRequestInterface $request;
public function __construct(
protected readonly IconFactory $iconFactory,
protected readonly UriBuilder $uriBuilder,
protected readonly TranslationConfigurationProvider $translateTools,
protected readonly EventDispatcherInterface $eventDispatcher,
protected readonly BackendViewFactory $backendViewFactory,
protected readonly ModuleProvider $moduleProvider,
) {
$this->calcPerms = new Permission();
$this->spaceIcon = '<span class="btn btn-default disabled" aria-hidden="true">' . $this->iconFactory->getIcon('empty-empty', Icon::SIZE_SMALL)->render() . '</span>';
}
public function setRequest(ServerRequestInterface $request)
{
$this->request = $request;
}
/**
* Returns a list of all fields / columns including meta columns such as
* "_REF_" or "_PATH_" which should be rendered for the database table.
*/
public function getColumnsToRender(string $table, bool $includeMetaColumns): array
{
$titleCol = $GLOBALS['TCA'][$table]['ctrl']['label'] ?? '';
// Setting fields selected in columnSelectorBox (saved in uc)
$rowListArray = [];
if (is_array($this->setFields[$table] ?? null)) {
$rowListArray = BackendUtility::getAllowedFieldsForTable($table);
if ($includeMetaColumns) {
$rowListArray[] = '_PATH_';
$rowListArray[] = '_REF_';
}
$rowListArray = array_intersect($rowListArray, $this->setFields[$table]);
}
// if no columns have been specified, show description (if configured)
if (!empty($GLOBALS['TCA'][$table]['ctrl']['descriptionColumn']) && empty($rowListArray)) {
$rowListArray[] = $GLOBALS['TCA'][$table]['ctrl']['descriptionColumn'];
}
// Initialize columns to select
$columnsToSelect = [$titleCol];
if ($includeMetaColumns) {
// If meta columns are enabled, add the record icon
array_unshift($columnsToSelect, 'icon');
if ($this->noControlPanels === false) {
// Add _SELECTOR_ as first item in case control panels are not disabled
array_unshift($columnsToSelect, '_SELECTOR_');
// Control-Panel
$columnsToSelect[] = '_CONTROL_';
}
// Path
if (!in_array('_PATH_', $rowListArray, true) && $this->searchLevels) {
$columnsToSelect[] = '_PATH_';
}
// Localization
if (BackendUtility::isTableLocalizable($table)) {
$columnsToSelect[] = '_LOCALIZATION_';
// Do not show the "Localize to:" field when only translated records should be shown
if (!$this->showOnlyTranslatedRecords) {
$columnsToSelect[] = '_LOCALIZATION_b';
}
}
}
return array_unique(array_merge($columnsToSelect, $rowListArray));
}
/**
* Based on the columns which should be rendered this method returns a list of actual
* database fields to be selected from the query string.
*
* @return string[] a list of all database table fields
*/
public function getFieldsToSelect(string $table, array $columnsToRender): array
{
$selectFields = $columnsToRender;
$selectFields[] = 'uid';
$selectFields[] = 'pid';
if ($table === 'pages') {
$selectFields[] = 'module';
$selectFields[] = 'extendToSubpages';
$selectFields[] = 'nav_hide';
$selectFields[] = 'doktype';
$selectFields[] = 'shortcut';
$selectFields[] = 'shortcut_mode';
$selectFields[] = 'mount_pid';
}
if (is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns'] ?? null)) {
$selectFields = array_merge($selectFields, array_values($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']));
}
foreach (['type', 'typeicon_column', 'editlock'] as $field) {
if ($GLOBALS['TCA'][$table]['ctrl'][$field] ?? false) {
$selectFields[] = $GLOBALS['TCA'][$table]['ctrl'][$field];
}
}
if (BackendUtility::isTableWorkspaceEnabled($table)) {
$selectFields[] = 't3ver_state';
$selectFields[] = 't3ver_wsid';
$selectFields[] = 't3ver_oid';
}
if (BackendUtility::isTableLocalizable($table)) {
$selectFields[] = $GLOBALS['TCA'][$table]['ctrl']['languageField'];
$selectFields[] = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'];
}
if ($GLOBALS['TCA'][$table]['ctrl']['label_alt'] ?? false) {
$selectFields = array_merge(
$selectFields,
GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], true)
);
}
// Unique list!
$selectFields = array_unique($selectFields);
$fieldListFields = BackendUtility::getAllowedFieldsForTable($table, false);
// Making sure that the fields in the field-list ARE in the field-list from TCA!
return array_intersect($selectFields, $fieldListFields);
}
/**
* Creates the listing of records from a single table
*
* @param string $table Table name
* @throws \UnexpectedValueException
* @return string HTML table with the listing for the record.
*/
public function getTable($table)
{
// Finding the total amount of records on the page
$queryBuilderTotalItems = $this->getQueryBuilder($table, ['*'], false, 0, 1);
$totalItems = (int)$queryBuilderTotalItems->count('*')
->executeQuery()
->fetchOne();
if ($totalItems === 0) {
return '';
}
// set the limits
// Use default value and overwrite with page ts config and tca config depending on the current view
// Force limit in range 5, 10000
// default 100
$itemsLimitSingleTable = MathUtility::forceIntegerInRange((int)(
$GLOBALS['TCA'][$table]['interface']['maxSingleDBListItems'] ??
$this->modTSconfig['itemsLimitSingleTable'] ??
100
), 5, 10000);
// default 20
$itemsLimitPerTable = MathUtility::forceIntegerInRange((int)(
$GLOBALS['TCA'][$table]['interface']['maxDBListItems'] ??
$this->modTSconfig['itemsLimitPerTable'] ??
20
), 5, 10000);
// Set limit depending on the view (single table vs. default)
$itemsPerPage = $this->table ? $itemsLimitSingleTable : $itemsLimitPerTable;
// Set limit defined by calling code
if ($this->showLimit) {
$itemsPerPage = $this->showLimit;
}
// Set limit from search
if ($this->searchString) {
$itemsPerPage = $totalItems;
}
// Init
$titleCol = $GLOBALS['TCA'][$table]['ctrl']['label'];
$l10nEnabled = BackendUtility::isTableLocalizable($table);
$this->fieldArray = $this->getColumnsToRender($table, true);
// Creating the list of fields to include in the SQL query
$selectFields = $this->getFieldsToSelect($table, $this->fieldArray);
$firstElement = ($this->page - 1) * $itemsPerPage;
if ($firstElement > 2 && $itemsPerPage > 0) {
// Get the two previous rows for sorting if displaying page > 1
$firstElement -= 2;
$itemsPerPage += 2;
$queryBuilder = $this->getQueryBuilder($table, $selectFields, true, $firstElement, $itemsPerPage);
$firstElement += 2;
$itemsPerPage -= 2;
} else {
$queryBuilder = $this->getQueryBuilder($table, $selectFields, true, $firstElement, $itemsPerPage);
}
$queryResult = $queryBuilder->executeQuery();
$columnsOutput = '';
$onlyShowRecordsInSingleTableMode = $this->listOnlyInSingleTableMode && !$this->table;
// Fetch records only if not in single table mode
if ($onlyShowRecordsInSingleTableMode) {
$dbCount = $totalItems;
} elseif ($firstElement + $itemsPerPage <= $totalItems) {
$dbCount = $itemsPerPage + 2;
} else {
$dbCount = $totalItems - $firstElement + 2;
}
// If any records was selected, render the list:
if ($dbCount === 0) {
return '';
}
// Get configuration of collapsed tables from user uc
$lang = $this->getLanguageService();
$tableIdentifier = $table;
// Use a custom table title for translated pages
if ($table === 'pages' && $this->showOnlyTranslatedRecords) {
// pages records in list module are split into two own sections, one for pages with
// sys_language_uid = 0 "Page" and an own section for sys_language_uid > 0 "Page Translation".
// This if sets the different title for the page translation case and a unique table identifier
// which is used in DOM as id.
$tableTitle = htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:pageTranslation'));
$tableIdentifier = 'pages_translated';
} else {
$tableTitle = htmlspecialchars($lang->sL($GLOBALS['TCA'][$table]['ctrl']['title']));
if ($tableTitle === '') {
$tableTitle = $table;
}
}
$backendUser = $this->getBackendUserAuthentication();
$tableCollapsed = (bool)($this->moduleData?->get('collapsedTables')[$tableIdentifier] ?? false);
// Header line is drawn
$theData = [];
if ($this->disableSingleTableView) {
$theData[$titleCol] = $tableTitle . ' (<span class="t3js-table-total-items">' . $totalItems . '</span>)';
} else {
$icon = $this->table // @todo separate table header from contract/expand link
? $this->iconFactory
->getIcon('actions-view-table-collapse', Icon::SIZE_SMALL)
->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:contractView'))
->render()
: $this->iconFactory
->getIcon('actions-view-table-expand', Icon::SIZE_SMALL)
->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:expandView'))
->render();
$theData[$titleCol] = $this->linkWrapTable($table, $tableTitle . ' (<span class="t3js-table-total-items">' . $totalItems . '</span>) ' . $icon);
}
$tableActions = '';
$tableHeader = $theData[$titleCol];
if (!$onlyShowRecordsInSingleTableMode) {
// Add the "new record" button
$tableActions .= $this->createActionButtonNewRecord($table) ?? '';
// Show the select box
$tableActions .= $this->createActionButtonColumnSelector($table) ?? '';
// Create the Download button
$tableActions .= $this->createActionButtonDownload($table, $totalItems) ?? '';
// Render collapse button if in multi table mode
$tableActions .= $this->createActionButtonCollapse($table) ?? '';
}
$currentIdList = [];
// Render table rows only if in multi table view or if in single table view
$rowOutput = '';
if (!$onlyShowRecordsInSingleTableMode || $this->table) {
// Fixing an order table for sortby tables
$this->currentTable = [];
$allowManualSorting = ($GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? false) && !$this->sortField;
$prevUid = 0;
$prevPrevUid = 0;
// Get first two rows and initialize prevPrevUid and prevUid if on page > 1
if ($firstElement > 2 && $itemsPerPage > 0) {
$row = $queryResult->fetchAssociative();
$prevPrevUid = -((int)$row['uid']);
$row = $queryResult->fetchAssociative();
$prevUid = $row['uid'];
}
$accRows = [];
// Accumulate rows here
while ($row = $queryResult->fetchAssociative()) {
if (!$this->isRowListingConditionFulfilled($table, $row)) {
continue;
}
// In offline workspace, look for alternative record
BackendUtility::workspaceOL($table, $row, $backendUser->workspace, true);
if (is_array($row)) {
$accRows[] = $row;
$currentIdList[] = $row['uid'];
if ($allowManualSorting) {
if ($prevUid) {
$this->currentTable['prev'][$row['uid']] = $prevPrevUid;
$this->currentTable['next'][$prevUid] = '-' . $row['uid'];
$this->currentTable['prevUid'][$row['uid']] = $prevUid;
}
$prevPrevUid = isset($this->currentTable['prev'][$row['uid']]) ? -$prevUid : $row['pid'];
$prevUid = $row['uid'];
}
}
}
// Render items:
$this->CBnames = [];
$this->duplicateStack = [];
$cc = 0;
// If no search happened it means that the selected
// records are either default or All language and here we will not select translations
// which point to the main record:
$listTranslatedRecords = $l10nEnabled && $this->searchString === '' && !($this->hideTranslations === '*' || GeneralUtility::inList($this->hideTranslations, $table));
foreach ($accRows as $row) {
// Render item row if counter < limit
if ($cc < $itemsPerPage) {
$cc++;
// Reset translations
$translations = [];
// Initialize with FALSE which causes the localization panel to not be displayed as
// the record is already localized, in free mode or has sys_language_uid -1 set.
// Only set to TRUE if TranslationConfigurationProvider::translationInfo() returns
// an array indicating the record can be translated.
$translationEnabled = false;
// Guard clause so we can quickly return if a record is localized to "all languages"
// It should only be possible to localize a record off default (uid 0)
if ($l10nEnabled && ($row[$GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? null] ?? false) !== -1) {
$translationsRaw = $this->translateTools->translationInfo($table, $row['uid'], 0, $row, $selectFields);
if (is_array($translationsRaw)) {
$translationEnabled = true;
$translations = $translationsRaw['translations'] ?? [];
}
}
$rowOutput .= $this->renderListRow($table, $row, 0, $translations, $translationEnabled);
if ($listTranslatedRecords) {
foreach ($translations ?? [] as $lRow) {
if (!$this->isRowListingConditionFulfilled($table, $lRow)) {
continue;
}
// In offline workspace, look for alternative record:
BackendUtility::workspaceOL($table, $lRow, $backendUser->workspace, true);
if (is_array($lRow) && $backendUser->checkLanguageAccess($lRow[$GLOBALS['TCA'][$table]['ctrl']['languageField']])) {
$currentIdList[] = $lRow['uid'];
$rowOutput .= $this->renderListRow($table, $lRow, 1, [], false);
}
}
}
}
}
// Record navigation is added to the beginning and end of the table if in single table mode
if ($this->table) {
$pagination = $this->renderListNavigation($this->table, $totalItems, $itemsPerPage);
$rowOutput = $pagination . $rowOutput . $pagination;
} elseif ($totalItems > $itemsLimitPerTable) {
// Show that there are more records than shown
$rowOutput .= '
<tr data-multi-record-selection-element="true">
<td colspan="' . (count($this->fieldArray)) . '">
<a href="' . htmlspecialchars($this->listURL() . '&table=' . rawurlencode($tableIdentifier)) . '" class="btn btn-sm btn-default">
' . $this->iconFactory->getIcon('actions-caret-down', Icon::SIZE_SMALL)->render() . '
' . $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.expandTable') . '
</a>
</td>
</tr>';
}
// The header row for the table is now created
$columnsOutput = $this->renderListHeader($table, $currentIdList);
}
// Initialize multi record selection actions
$multiRecordSelectionActions = '';
if ($this->noControlPanels === false) {
$multiRecordSelectionActions = '
<div class="recordlist-heading-row t3js-multi-record-selection-actions hidden">
<div class="recordlist-heading-title">
<strong>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.selection')) . '</strong>
</div>
<div class="recordlist-heading-actions">
' . $this->renderMultiRecordSelectionActions($table, $currentIdList) . '
</div>
</div>
';
}
$recordListMessages = '';
$recordlistMessageEntries = [];
if ($backendUser->workspace > 0 && ExtensionManagementUtility::isLoaded('workspaces') && !BackendUtility::isTableWorkspaceEnabled($table)) {
// In case the table is not editable in workspace inform the user about the missing actions
if ($backendUser->workspaceAllowsLiveEditingInTable($table)) {
$recordlistMessageEntries[] = [
'message' => $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.editingLiveRecordsWarning'),
'severity' => ContextualFeedbackSeverity::WARNING,
];
} else {
$recordlistMessageEntries[] = [
'message' => $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.notEditableInWorkspace'),
'severity' => ContextualFeedbackSeverity::INFO,
];
}
}
foreach ($recordlistMessageEntries as $messageEntry) {
$recordListMessages .= '<div class="alert alert-' . $messageEntry['severity']->getCssClass() . '">';
$recordListMessages .= $this->iconFactory->getIcon($messageEntry['severity']->getIconIdentifier(), Icon::SIZE_SMALL)->render();
$recordListMessages .= ' ';
$recordListMessages .= htmlspecialchars($messageEntry['message'], ENT_QUOTES | ENT_HTML5);
$recordListMessages .= '</div>';
}
$collapseClass = $tableCollapsed && !$this->table ? 'collapse' : 'collapse show';
$dataState = $tableCollapsed && !$this->table ? 'collapsed' : 'expanded';
return '
<div class="recordlist" id="t3-table-' . htmlspecialchars($tableIdentifier) . '" data-multi-record-selection-identifier="t3-table-' . htmlspecialchars($tableIdentifier) . '">
<form action="' . htmlspecialchars($this->listURL()) . '#t3-table-' . htmlspecialchars($tableIdentifier) . '" method="post" name="list-table-form-' . htmlspecialchars($tableIdentifier) . '">
<input type="hidden" name="cmd_table" value="' . htmlspecialchars($tableIdentifier) . '" />
<input type="hidden" name="cmd" />
<div class="recordlist-heading ' . ($multiRecordSelectionActions !== '' ? 'multi-record-selection-panel' : '') . '">
<div class="recordlist-heading-row">
<div class="recordlist-heading-title">' . $tableHeader . '</div>
<div class="recordlist-heading-actions">' . $tableActions . '</div>
</div>
' . $multiRecordSelectionActions . '
</div>
' . $recordListMessages . '
<div class="' . $collapseClass . '" data-state="' . $dataState . '" id="recordlist-' . htmlspecialchars($tableIdentifier) . '">
<div class="table-fit">
<table data-table="' . htmlspecialchars($tableIdentifier) . '" class="table table-striped table-hover">
<thead>
' . $columnsOutput . '
</thead>
<tbody data-multi-record-selection-row-selection="true">
' . $rowOutput . '
</tbody>
</table>
</div>
</div>
</form>
</div>
';
}
/**
* If new records can be created on this page, create a button
*/
protected function createActionButtonNewRecord(string $table): ?ButtonInterface
{
if (!$this->isEditable($table)) {
return null;
}
if (!$this->showNewRecLink($table)) {
return null;
}
$permsAdditional = ($table === 'pages' ? Permission::PAGE_NEW : Permission::CONTENT_EDIT);
if (!$this->calcPerms->isGranted($permsAdditional)) {
return null;
}
$tag = 'a';
$iconIdentifier = 'actions-plus';
$label = sprintf(
$this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:newRecordOfType'),
$this->getLanguageService()->sL($GLOBALS['TCA'][$table]['ctrl']['title'])
);
$attributes = [
'data-recordlist-action' => 'new',
];
if ($table === 'tt_content') {
$tag = 'typo3-backend-new-content-element-wizard-button';
$attributes['url'] = (string)$this->uriBuilder->buildUriFromRoute(
'new_content_element_wizard',
[
'id' => $this->id,
'returnUrl' => $this->listURL(),
]
);
} elseif ($table === 'pages') {
$iconIdentifier = 'actions-page-new';
$attributes['data-new'] = 'page';
$attributes['href'] = (string)$this->uriBuilder->buildUriFromRoute(
'db_new_pages',
['id' => $this->id, 'returnUrl' => $this->listURL()]
);
} else {
$attributes['href'] = $this->uriBuilder->buildUriFromRoute(
'record_edit',
[
'edit' => [
$table => [
$this->id => 'new',
],
],
'returnUrl' => $this->listURL(),
]
);
}
$button = GeneralUtility::makeInstance(GenericButton::class);
$button->setTag($tag);
$button->setLabel($label);
$button->setShowLabelText(true);
$button->setIcon($this->iconFactory->getIcon($iconIdentifier, Icon::SIZE_SMALL));
$button->setAttributes($attributes);
return $button;
}
protected function createActionButtonDownload(string $table, int $totalItems): ?ButtonInterface
{
// Do not render the download button for page translations or in case it is disabled
if (!$this->displayRecordDownload
|| ($this->modTSconfig['noExportRecordsLinks'] ?? false)
|| $this->showOnlyTranslatedRecords
) {
return null;
}
$downloadButtonLabel = $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_download.xlf:download');
$downloadButtonTitle = sprintf($this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_download.xlf:' . ($totalItems === 1 ? 'downloadRecord' : 'downloadRecords')), $totalItems);
$downloadCancelTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.cancel');
$downloadSettingsUrl = $this->uriBuilder->buildUriFromRoute(
'ajax_record_download_settings',
['id' => $this->id, 'table' => $table, 'searchString' => $this->searchString, 'searchLevels' => $this->searchLevels]
);
$downloadSettingsTitle = sprintf(
$this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_download.xlf:' . ($totalItems === 1 ? 'downloadRecordSettings' : 'downloadRecordsSettings')),
$this->getLanguageService()->sL($GLOBALS['TCA'][$table]['ctrl']['title'] ?? '') ?: $table,
$totalItems
);
$button = GeneralUtility::makeInstance(GenericButton::class);
$button->setTag('typo3-recordlist-record-download-button');
$button->setLabel($downloadButtonLabel);
$button->setShowLabelText(true);
$button->setIcon($this->iconFactory->getIcon('actions-download', Icon::SIZE_SMALL));
$button->setAttributes([
'url' => $downloadSettingsUrl,
'subject' => $downloadSettingsTitle,
'ok' => $downloadButtonTitle,
'close' => $downloadCancelTitle,
'data-recordlist-action' => 'download',
]);
return $button;
}
/**
* Creates a button, which triggers a modal for the column selection
*/
protected function createActionButtonColumnSelector(string $table): ?ButtonInterface
{
if ($this->displayColumnSelector === false) {
// Early return in case column selector is disabled
return null;
}
$shouldRenderSelector = true;
// See if it is disabled in general
if (isset($this->modTSconfig['displayColumnSelector'])) {
$shouldRenderSelector = (bool)$this->modTSconfig['displayColumnSelector'];
}
// Table override was explicitly set to false
if (isset($this->modTSconfig['table.'][$table . '.']['displayColumnSelector'])) {
$shouldRenderSelector = (bool)$this->modTSconfig['table.'][$table . '.']['displayColumnSelector'];
}
// Do not render button if column selector is disabled
if ($shouldRenderSelector === false) {
return null;
}
$lang = $this->getLanguageService();
$tableIdentifier = $table . (($table === 'pages' && $this->showOnlyTranslatedRecords) ? '_translated' : '');
$columnSelectorUrl = (string)$this->uriBuilder->buildUriFromRoute(
'ajax_show_columns_selector',
['id' => $this->id, 'table' => $table]
);
$columnSelectorTitle = sprintf(
$lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_column_selector.xlf:showColumnsSelection'),
$lang->sL($GLOBALS['TCA'][$table]['ctrl']['title'] ?? '') ?: $table,
);
$button = GeneralUtility::makeInstance(GenericButton::class);
$button->setTag('typo3-backend-column-selector-button');
$button->setLabel($lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_column_selector.xlf:showColumns'));
$button->setShowLabelText(true);
$button->setIcon($this->iconFactory->getIcon('actions-options', Icon::SIZE_SMALL));
$button->setAttributes([
'data-url' => $columnSelectorUrl,
'data-target' => $this->listURL() . '#t3-table-' . $tableIdentifier,
'data-title' => $columnSelectorTitle,
'data-button-ok' => $lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_column_selector.xlf:updateColumnView'),
'data-button-close' => $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.cancel'),
'data-error-message' => $lang->sL('LLL:EXT:backend/Resources/Private/Language/locallang_column_selector.xlf:updateColumnView.error'),
'data-recordlist-action' => 'columns',
]);
return $button;
}
protected function createActionButtonCollapse(string $table): ?ButtonInterface
{
if ($this->table !== '') {
return null;
}
$tableIdentifier = $table . (($table === 'pages' && $this->showOnlyTranslatedRecords) ? '_translated' : '');
$tableCollapsed = (bool)($this->moduleData?->get('collapsedTables')[$tableIdentifier] ?? false);
$button = GeneralUtility::makeInstance(GenericButton::class);
$button->setLabel(sprintf(
$this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:collapseExpandTable'),
$this->getLanguageService()->sL($GLOBALS['TCA'][$table]['ctrl']['title'])
));
$button->setClasses('t3js-toggle-recordlist');
$button->setIcon($this->iconFactory->getIcon(($tableCollapsed ? 'actions-view-list-expand' : 'actions-view-list-collapse'), Icon::SIZE_SMALL));
$button->setAttributes([
'aria-expanded' => ($tableCollapsed ? 'false' : 'true'),
'data-table' => $tableIdentifier,
'data-recordlist-action' => 'toggle',
'data-bs-toggle' => 'collapse',
'data-bs-target' => '#recordlist-' . $tableIdentifier,
]);
return $button;
}
/**
* Get preview link for pages or tt_content records
*/
protected function getPreviewUriBuilder(string $table, array $row): PreviewUriBuilder
{
if ($table === 'tt_content') {
// Link to a content element, possibly translated and with anchor
$previewUriBuilder = PreviewUriBuilder::create($this->id)
->withSection('#c' . $row['uid'])
->withLanguage((int)($row[$GLOBALS['TCA']['tt_content']['ctrl']['languageField'] ?? null] ?? 0));
} elseif ($table === 'pages' && ($row[$GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'] ?? null] ?? 0) > 0) {
// Link to a page translation needs uid of default language page as id
$previewUriBuilder = PreviewUriBuilder::create((int)$row[$GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField']])
->withSection('#c' . $row['uid'])
->withLanguage((int)($row[$GLOBALS['TCA']['pages']['ctrl']['languageField'] ?? null] ?? 0));
} else {
// Link to a page in the default language
$previewUriBuilder = PreviewUriBuilder::create((int)($row['uid'] ?? 0));
}
return $previewUriBuilder;
}
/**
* Check if all row listing conditions are fulfilled.
*
* This function serves as a dummy method to be overridden in extending classes.
*
* @param string $table Table name
* @param string[] $row Record
* @return bool True, if all conditions are fulfilled.
*/
protected function isRowListingConditionFulfilled($table, $row)
{
return true;
}
/**
* Rendering a single row for the list
*
* @param string $table Table name
* @param mixed[] $row Current record
* @param int $indent Indent from left.
* @param array $translations Array of already existing translations for the current record
* @param bool $translationEnabled Whether the record can be translated
* @return string Table row for the element
* @internal
* @see getTable()
*/
public function renderListRow($table, array $row, int $indent, array $translations, bool $translationEnabled)
{
$titleCol = $GLOBALS['TCA'][$table]['ctrl']['label'] ?? '';
$languageService = $this->getLanguageService();
$rowOutput = '';
$id_orig = $this->id;
// If in search mode, make sure the preview will show the correct page
if ((string)$this->searchString !== '') {
$this->id = $row['pid'];
}
$tagAttributes = [
'class' => [],
'data-table' => $table,
'title' => 'id=' . $row['uid'],
];
// Add active class to record of current link
if (
isset($this->currentLink['tableNames'])
&& (int)$this->currentLink['uid'] === (int)$row['uid']
&& GeneralUtility::inList($this->currentLink['tableNames'], $table)
) {
$tagAttributes['class'][] = 'active';
}
// Overriding with versions background color if any:
if (!empty($row['_CSSCLASS'])) {
$tagAttributes['class'] = [$row['_CSSCLASS']];
}
$tagAttributes['class'][] = 't3js-entity';
// Preparing and getting the data-array
$theData = [];
$deletePlaceholderClass = '';
foreach ($this->fieldArray as $fCol) {
if ($fCol === $titleCol) {
$recTitle = BackendUtility::getRecordTitle($table, $row, false, true);
$warning = '';
// If the record is edit-locked by another user, we will show a little warning sign:
$lockInfo = BackendUtility::isRecordLocked($table, $row['uid']);
if ($lockInfo) {
$warning = '<span tabindex="0"'
. ' title="' . htmlspecialchars($lockInfo['msg']) . '"'
. ' aria-label="' . htmlspecialchars($lockInfo['msg']) . '">'
. $this->iconFactory->getIcon('status-user-backend', Icon::SIZE_SMALL, 'overlay-edit')->render()
. '</span>';
}
if ($this->isRecordDeletePlaceholder($row)) {
// Delete placeholder records do not link to formEngine edit and are rendered strike-through
$deletePlaceholderClass = ' deletePlaceholder';
$theData[$fCol] = $theData['__label'] =
$warning
. '<span title="' . htmlspecialchars($languageService->sL('LLL:EXT:backend/Resources/Private/Language/locallang.xlf:row.deletePlaceholder.title')) . '">'
. htmlspecialchars($recTitle)
. '</span>';
} else {
$theData[$fCol] = $theData['__label'] = $warning . $this->linkWrapItems($table, $row['uid'], $recTitle, $row);
}
} elseif ($fCol === 'pid') {
$theData[$fCol] = $row[$fCol];
} elseif ($fCol === '_SELECTOR_') {
if ($table !== 'pages' || !$this->showOnlyTranslatedRecords) {
// Add checkbox for all tables except the special page translations table
$theData[$fCol] = $this->makeCheckbox($table, $row);
} else {
// Remove "_SELECTOR_", which is always the first item, from the field list
array_splice($this->fieldArray, 0, 1);
}
} elseif ($fCol === 'icon') {
$icon = $this->iconFactory
->getIconForRecord($table, $row, Icon::SIZE_SMALL)
->setTitle(BackendUtility::getRecordIconAltText($row, $table))
->render();
$theData[$fCol] = ''
. ($indent ? '<span class="indent indent-inline-block" style="--indent-level: ' . $indent . '"></span> ' : '')
. (($this->clickMenuEnabled && !$this->isRecordDeletePlaceholder($row)) ? BackendUtility::wrapClickMenuOnIcon($icon, $table, $row['uid']) : $icon);
} elseif ($fCol === '_PATH_') {
$theData[$fCol] = $this->recPath($row['pid']);
} elseif ($fCol === '_REF_') {
$theData[$fCol] = $this->generateReferenceToolTip($table, $row['uid']);
} elseif ($fCol === '_CONTROL_') {
$theData[$fCol] = $this->makeControl($table, $row);
} elseif ($fCol === '_LOCALIZATION_') {
// Language flag an title
$theData[$fCol] = $this->languageFlag($table, $row);
// Localize record
$localizationPanel = $translationEnabled ? $this->makeLocalizationPanel($table, $row, $translations) : '';
if ($localizationPanel !== '') {
$theData['_LOCALIZATION_b'] = '<div class="btn-group">' . $localizationPanel . '</div>';
$this->showLocalizeColumn[$table] = true;
}
} elseif ($fCol !== '_LOCALIZATION_b') {
// default for all other columns, except "_LOCALIZATION_b"
$pageId = $table === 'pages' ? $row['uid'] : $row['pid'];
$tmpProc = BackendUtility::getProcessedValueExtra($table, $fCol, $row[$fCol], 100, $row['uid'], true, $pageId);
$theData[$fCol] = $this->linkUrlMail(htmlspecialchars((string)$tmpProc), (string)($row[$fCol] ?? ''));
}
}
// Reset the ID if it was overwritten
if ((string)$this->searchString !== '') {
$this->id = $id_orig;
}
// Add classes to table cells
$this->addElement_tdCssClass['_SELECTOR_'] = 'col-checkbox';
$this->addElement_tdCssClass[$titleCol] = 'col-title col-responsive' . $deletePlaceholderClass;
$this->addElement_tdCssClass['__label'] = $this->addElement_tdCssClass[$titleCol];
$this->addElement_tdCssClass['icon'] = 'col-icon';
$this->addElement_tdCssClass['_CONTROL_'] = 'col-control';
$this->addElement_tdCssClass['_PATH_'] = 'col-path';
$this->addElement_tdCssClass['_LOCALIZATION_'] = 'col-localizationa';
$this->addElement_tdCssClass['_LOCALIZATION_b'] = 'col-localizationb';
// Create element in table cells:
$theData['uid'] = $row['uid'];
if (isset($GLOBALS['TCA'][$table]['ctrl']['languageField'])
&& isset($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
) {
$theData['_l10nparent_'] = $row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']];
}
$tagAttributes = array_map(
static function ($attributeValue) {
if (is_array($attributeValue)) {
return implode(' ', $attributeValue);
}
return $attributeValue;
},
$tagAttributes
);
$rowOutput .= $this->addElement($theData, GeneralUtility::implodeAttributes($tagAttributes, true));
// Finally, return table row element:
return $rowOutput;
}
/**
* Gets the number of records referencing the record with the UID $uid in
* the table $tableName.
*
* @param string $tableName
* @param int $uid
* @return int The number of references to record $uid in table
*/
protected function getReferenceCount($tableName, $uid)
{
if (!isset($this->referenceCount[$tableName][$uid])) {
$referenceIndex = GeneralUtility::makeInstance(ReferenceIndex::class);
$numberOfReferences = $referenceIndex->getNumberOfReferencedRecords($tableName, $uid);
$this->referenceCount[$tableName][$uid] = $numberOfReferences;
}
return $this->referenceCount[$tableName][$uid];
}
/**
* Rendering the header row for a table
*
* @param string $table Table name
* @param int[] $currentIdList Array of the currently displayed uids of the table
* @throws \UnexpectedValueException
* @return string Header table row
* @internal
* @see getTable()
*/
public function renderListHeader($table, $currentIdList)
{
$tsConfig = BackendUtility::getPagesTSconfig($this->id)['TCEFORM.'][$table . '.'] ?? null;
$tsConfigOfTable = is_array($tsConfig) ? $tsConfig : null;
$lang = $this->getLanguageService();
// Init:
$theData = [];
// Traverse the fields:
foreach ($this->fieldArray as $fCol) {
// Calculate users permissions to edit records in the table:
if ($table === 'pages') {
$permsEdit = $this->calcPerms->editPagePermissionIsGranted();
} else {
$permsEdit = $this->calcPerms->editContentPermissionIsGranted();
}
$permsEdit = $permsEdit && $this->overlayEditLockPermissions($table);
switch ((string)$fCol) {
case '_SELECTOR_':
if ($table !== 'pages' || !$this->showOnlyTranslatedRecords) {
// Add checkbox actions for all tables except the special page translations table
$theData[$fCol] = $this->renderCheckboxActions();
} else {
// Remove "_SELECTOR_", which is always the first item, from the field list
array_splice($this->fieldArray, 0, 1);
}
break;
case 'icon':
// In case no checkboxes are rendered (page translations or disabled) add the icon
// column, otherwise the selector column is using "colspan=2"
if (!in_array('_SELECTOR_', $this->fieldArray, true)
|| ($table === 'pages' && $this->showOnlyTranslatedRecords)
) {
$theData[$fCol] = '';
}
break;
case '_CONTROL_':
$theData[$fCol] = '<i class="hidden">' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels._CONTROL_')) . '</i>';
// In single table view, add button to edit displayed fields of marked / listed records
if ($this->table && $permsEdit && is_array($currentIdList) && $this->isEditable($table)) {
$label = htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:editShownColumns'));
$theData[$fCol] = '<button type="button"'
. ' class="btn btn-default t3js-record-edit-multiple"'
. ' title="' . $label . '"'
. ' aria-label="' . $label . '"'
. ' data-return-url="' . htmlspecialchars($this->listURL()) . '"'
. ' data-columns-only="' . htmlspecialchars(implode(',', $this->fieldArray)) . '">'
. $this->iconFactory->getIcon('actions-document-open', Icon::SIZE_SMALL)->render()
. '</button>';
}
break;
case '_PATH_':
// Path
$theData[$fCol] = '<i>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels._PATH_')) . '</i>';
break;
case '_REF_':
// References
$theData[$fCol] = '<i>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels._REF_')) . '</i>';
break;
case '_LOCALIZATION_':
// Show language of record
$theData[$fCol] = '<i>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels._LOCALIZATION_')) . '</i>';
break;
case '_LOCALIZATION_b':
// Show translation options
if ($this->showLocalizeColumn[$table] ?? false) {
$theData[$fCol] = '<i>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:Localize')) . '</i>';
}
break;
default:
// Regular fields header
$theData[$fCol] = '';
// Check if $fCol is really a field and get the label and remove the colons at the end
$sortLabel = BackendUtility::getItemLabel($table, $fCol);
if ($sortLabel !== null) {
// Field label
$fieldTSConfig = [];
if (isset($tsConfigOfTable[$fCol . '.'])
&& is_array($tsConfigOfTable[$fCol . '.'])
) {
$fieldTSConfig = $tsConfigOfTable[$fCol . '.'];
}
$sortLabel = $lang->translateLabel(
$fieldTSConfig['label.'] ?? [],
$fieldTSConfig['label'] ?? $sortLabel
);
$sortLabel = htmlspecialchars(rtrim(trim($sortLabel), ':'));
} elseif ($specialLabel = $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.' . $fCol)) {
// Special label exists for this field (Probably a management field, e.g. sorting)
$sortLabel = htmlspecialchars($specialLabel);
} else {
// No TCA field, only output the $fCol variable with square brackets []
$sortLabel = htmlspecialchars($fCol);
$sortLabel = '<i>[' . rtrim(trim($sortLabel), ':') . ']</i>';
}
if ($this->table && is_array($currentIdList)) {
// If the numeric clipboard pads are selected, show duplicate sorting link:
if ($this->noControlPanels === false
&& $this->isClipboardFunctionalityEnabled($table)
&& $this->clipObj->current !== 'normal'
) {
$theData[$fCol] .= '<a class="btn btn-default" href="' . htmlspecialchars($this->listURL() . '&duplicateField=' . $fCol)
. '" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:clip_duplicates')) . '">'
. $this->iconFactory->getIcon('actions-document-duplicates-select', Icon::SIZE_SMALL)->render() . '</a>';
}
// If the table can be edited, add link for editing THIS field for all
// listed records:
if ($this->isEditable($table) && $permsEdit && ($GLOBALS['TCA'][$table]['columns'][$fCol] ?? false)) {
$iTitle = sprintf($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:editThisColumn'), $sortLabel);
$theData[$fCol] .= '<button type="button"'
. ' class="btn btn-default t3js-record-edit-multiple"'
. ' title="' . htmlspecialchars($iTitle) . '"'
. ' aria-label="' . htmlspecialchars($iTitle) . '"'
. ' data-return-url="' . htmlspecialchars($this->listURL()) . '"'
. ' data-columns-only="' . htmlspecialchars($fCol) . '">'
. $this->iconFactory->getIcon('actions-document-open', Icon::SIZE_SMALL)->render()
. '</button>';
}
if (strlen($theData[$fCol]) > 0) {
$theData[$fCol] = '<div class="btn-group">' . $theData[$fCol] . '</div> ';
}
}
$theData[$fCol] .= $this->addSortLink($sortLabel, $fCol, $table);
}
}
$event = $this->eventDispatcher->dispatch(
new ModifyRecordListHeaderColumnsEvent($theData, $table, $currentIdList, $this)
);
// Create and return header table row:
return $this->addElement($event->getColumns(), GeneralUtility::implodeAttributes($event->getHeaderAttributes(), true), 'th');
}
/**
* Creates a page browser for tables with many records
*
* @return string Navigation HTML
*/
protected function renderListNavigation(string $table, int $totalItems, int $itemsPerPage): string
{
$currentPage = $this->page;
$paginationColumns = count($this->fieldArray);
$totalPages = (int)ceil($totalItems / $itemsPerPage);
// Show page selector if not all records fit into one page
if ($totalPages <= 1) {
return '';
}
if ($totalItems > $currentPage * $itemsPerPage) {
$lastElementNumber = $currentPage * $itemsPerPage;
} else {
$lastElementNumber = $totalItems;
}
$view = $this->backendViewFactory->create($this->request);
return $view->assignMultiple([
'currentUrl' => $this->listURL('', $table, 'pointer'),
'currentPage' => $currentPage,
'totalPages' => $totalPages,
'firstElement' => ((($currentPage - 1) * $itemsPerPage) + 1),
'lastElement' => $lastElementNumber,
'colspan' => $paginationColumns,
])
->render('ListNavigation');
}
/*********************************
*
* Rendering of various elements
*
*********************************/
/**
* Creates the control panel for a single record in the listing.
*
* @param string $table The table
* @param mixed[] $row The record for which to make the control panel.
* @throws \UnexpectedValueException
* @return string HTML table with the control panel (unless disabled)
*/
public function makeControl($table, $row)
{
$backendUser = $this->getBackendUserAuthentication();
$userTsConfig = $backendUser->getTSConfig();
$rowUid = $row['uid'];
if (ExtensionManagementUtility::isLoaded('workspaces') && isset($row['_ORIG_uid'])) {
$rowUid = $row['_ORIG_uid'];
}
$isDeletePlaceHolder = $this->isRecordDeletePlaceholder($row);
$cells = [
'primary' => [],
'secondary' => [],
];
// Hide the move elements for localized records - doesn't make much sense to perform these options for them
$isL10nOverlay = (int)($row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? null] ?? 0) !== 0;
$localCalcPerms = $this->getPagePermissionsForRecord($table, $row);
if ($table === 'pages') {
$permsEdit = ($backendUser->checkLanguageAccess($row[$GLOBALS['TCA']['pages']['ctrl']['languageField'] ?? null] ?? 0))
&& $localCalcPerms->editPagePermissionIsGranted();
} else {
$permsEdit = $localCalcPerms->editContentPermissionIsGranted() && $backendUser->recordEditAccessInternals($table, $row);
}
$permsEdit = $this->overlayEditLockPermissions($table, $row, $permsEdit);
// "Show" link (only pages and tt_content elements)
$tsConfig = BackendUtility::getPagesTSconfig($this->id)['mod.']['web_list.'] ?? [];
if ((
$table === 'pages'
&& isset($row['doktype'])
&& !in_array((int)$row['doktype'], $this->getNoViewWithDokTypes($tsConfig), true)
)
|| (
$table === 'tt_content'
&& isset($this->pageRow['doktype'])
&& !in_array((int)$this->pageRow['doktype'], $this->getNoViewWithDokTypes($tsConfig), true)
)
) {
if (!$isDeletePlaceHolder
&& ($attributes = $this->getPreviewUriBuilder($table, $row)->serializeDispatcherAttributes()) !== null
) {
$viewAction = '<button'
. ' type="button"'
. ' class="btn btn-default" ' . $attributes
. ' title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.showPage')) . '">';
if ($table === 'pages') {
$viewAction .= $this->iconFactory->getIcon('actions-view-page', Icon::SIZE_SMALL)->render();
} else {
$viewAction .= $this->iconFactory->getIcon('actions-view', Icon::SIZE_SMALL)->render();
}
$viewAction .= '</button>';
$this->addActionToCellGroup($cells, $viewAction, 'view');
} else {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'view');
}
} else {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'view');
}
// "Edit" link: ( Only if permissions to edit the page-record of the content of the parent page ($this->id)
if ($permsEdit && !$isDeletePlaceHolder && $this->isEditable($table)) {
$params = [
'edit' => [
$table => [
$row['uid'] => 'edit',
],
],
];
$iconIdentifier = 'actions-open';
if ($table === 'pages') {
// Disallow manual adjustment of the language field for pages
$params['overrideVals']['pages']['sys_language_uid'] = $row[$GLOBALS['TCA']['pages']['ctrl']['languageField'] ?? null] ?? 0;
$iconIdentifier = 'actions-page-open';
}
$params['returnUrl'] = $this->listURL();
$editLink = $this->uriBuilder->buildUriFromRoute('record_edit', $params);
$editAction = '<a class="btn btn-default" href="' . htmlspecialchars($editLink) . '"'
. ' title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:edit')) . '">' . $this->iconFactory->getIcon($iconIdentifier, Icon::SIZE_SMALL)->render() . '</a>';
} else {
$editAction = $this->spaceIcon;
}
$this->addActionToCellGroup($cells, $editAction, 'edit');
// "Info"
if (!$isDeletePlaceHolder) {
$label = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:showInfo'));
$viewBigAction = '<button type="button" aria-haspopup="dialog"'
. ' class="btn btn-default" '
. $this->createShowItemTagAttributes($table . ',' . ($row['uid'] ?? 0))
. ' title="' . $label . '"'
. ' aria-label="' . $label . '">'
. $this->iconFactory->getIcon('actions-document-info', Icon::SIZE_SMALL)->render()
. '</button>';
$this->addActionToCellGroup($cells, $viewBigAction, 'viewBig');
} else {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'viewBig');
}
// "Move" wizard link for pages/tt_content elements:
if ($permsEdit && ($table === 'tt_content' || $table === 'pages') && $this->isEditable($table)) {
if ($isL10nOverlay || $isDeletePlaceHolder) {
$moveAction = $this->spaceIcon;
} elseif ($table === 'pages') {
$linkTitleLL = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:move_page'));
$icon = $this->iconFactory->getIcon('actions-page-move', Icon::SIZE_SMALL);
$url = (string)$this->uriBuilder->buildUriFromRoute('move_page', [
'uid' => $row['uid'],
'returnUrl' => $this->listURL(),
]);
$moveAction = '<a class="btn btn-default" href="' . htmlspecialchars($url) . '" aria-label="' . $linkTitleLL . '">' . $icon->render() . '</a>';
} else {
$linkTitleLL = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:move_record'));
$icon = $this->iconFactory->getIcon('actions-document-move', Icon::SIZE_SMALL);
$url = (string)$this->uriBuilder->buildUriFromRoute('move_element', [
'uid' => $row['uid'],
'returnUrl' => $this->listURL(),
]);
$moveAction = '<a class="btn btn-default" href="' . htmlspecialchars($url) . '" aria-label="' . $linkTitleLL . '">' . $icon->render() . '</a>';
}
$this->addActionToCellGroup($cells, $moveAction, 'move');
}
// If the table is NOT a read-only table, then show these links:
if ($this->isEditable($table)) {
// "Revert" link (history/undo)
if (\trim($userTsConfig['options.']['showHistory.'][$table] ?? $userTsConfig['options.']['showHistory'] ?? '1')) {
if (!$isDeletePlaceHolder) {
$moduleUrl = $this->uriBuilder->buildUriFromRoute('record_history', [
'element' => $table . ':' . $row['uid'],
'returnUrl' => $this->listURL(),
]) . '#latest';
$historyAction = '<a class="btn btn-default" href="' . htmlspecialchars($moduleUrl) . '" title="'
. htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:history')) . '">'
. $this->iconFactory->getIcon('actions-document-history-open', Icon::SIZE_SMALL)->render() . '</a>';
$this->addActionToCellGroup($cells, $historyAction, 'history');
} else {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'history');
}
}
// "Edit Perms" link:
if ($table === 'pages' && $this->moduleProvider->accessGranted('permissions_pages', $backendUser)) {
if ($isL10nOverlay || $isDeletePlaceHolder) {
$permsAction = $this->spaceIcon;
} else {
$params = [
'id' => $row['uid'],
'action' => 'edit',
'returnUrl' => $this->listURL(),
];
$href = (string)$this->uriBuilder->buildUriFromRoute('permissions_pages', $params);
$permsAction = '<a class="btn btn-default" href="' . htmlspecialchars($href) . '" title="'
. htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:permissions')) . '">'
. $this->iconFactory->getIcon('actions-lock', Icon::SIZE_SMALL)->render() . '</a>';
}
$this->addActionToCellGroup($cells, $permsAction, 'perms');
}
// "New record after" link (ONLY if the records in the table are sorted by a "sortby"-row
// or if default values can depend on previous record):
if ((($GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? false) || ($GLOBALS['TCA'][$table]['ctrl']['useColumnsForDefaultValues'] ?? false)) && $permsEdit) {
$neededPermission = $table === 'pages' ? Permission::PAGE_NEW : Permission::CONTENT_EDIT;
if ($this->calcPerms->isGranted($neededPermission)) {
if ($isL10nOverlay || $isDeletePlaceHolder) {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'new');
} elseif ($this->showNewRecLink($table)) {
$params = [
'edit' => [
$table => [
(0 - (($row['_MOVE_PLH'] ?? 0) ? $row['_MOVE_PLH_uid'] : $row['uid'])) => 'new',
],
],
'returnUrl' => $this->listURL(),
];
$icon = ($table === 'pages' ? $this->iconFactory->getIcon('actions-page-new', Icon::SIZE_SMALL) : $this->iconFactory->getIcon('actions-plus', Icon::SIZE_SMALL));
$titleLabel = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:new');
if ($GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? false) {
$titleLabel = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:newRecord');
if ($table === 'pages') {
$titleLabel = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:newPage');
}
}
$newLink = $this->uriBuilder->buildUriFromRoute('record_edit', $params);
$newAction = '<a class="btn btn-default" href="' . htmlspecialchars($newLink) . '" title="' . htmlspecialchars($titleLabel) . '">'
. $icon->render() . '</a>';
$this->addActionToCellGroup($cells, $newAction, 'new');
}
}
}
// "Hide/Unhide" links:
$hiddenField = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'] ?? null;
if ($hiddenField !== null
&& !empty($GLOBALS['TCA'][$table]['columns'][$hiddenField])
&& (empty($GLOBALS['TCA'][$table]['columns'][$hiddenField]['exclude']) || $backendUser->check('non_exclude_fields', $table . ':' . $hiddenField))
) {
if (!$permsEdit || $isDeletePlaceHolder || $this->isRecordCurrentBackendUser($table, $row)) {
$hideAction = $this->spaceIcon;
} else {
$visibleTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:hide' . ($table === 'pages' ? 'Page' : ''));
$visibleIcon = 'actions-edit-hide';
$visibleValue = '0';
$hiddenTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:unHide' . ($table === 'pages' ? 'Page' : ''));
$hiddenIcon = 'actions-edit-unhide';
$hiddenValue = '1';
if ($row[$hiddenField] ?? false) {
$titleLabel = $hiddenTitle;
$iconIdentifier = $hiddenIcon;
$status = 'hidden';
} else {
$titleLabel = $visibleTitle;
$iconIdentifier = $visibleIcon;
$status = 'visible';
}
$attributesString = GeneralUtility::implodeAttributes(
[
'class' => 'btn btn-default',
'type' => 'button',
'title' => $titleLabel,
'data-datahandler-action' => 'visibility',
'data-datahandler-table' => $table,
'data-datahandler-uid' => $rowUid,
'data-datahandler-field' => $hiddenField,
'data-datahandler-status' => $status,
'data-datahandler-visible-label' => $visibleTitle,
'data-datahandler-visible-value' => $visibleValue,
'data-datahandler-visible-icon' => $visibleIcon,
'data-datahandler-hidden-label' => $hiddenTitle,
'data-datahandler-hidden-value' => $hiddenValue,
'data-datahandler-hidden-icon' => $hiddenIcon,
],
true
);
$hideAction = '<button ' . $attributesString . '>'
. $this->iconFactory->getIcon($iconIdentifier, Icon::SIZE_SMALL)
. '</button>';
}
$this->addActionToCellGroup($cells, $hideAction, 'hide');
}
// "Up/Down" links
if ($permsEdit && ($GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? false) && !$this->sortField && !$this->searchLevels) {
if (!$isL10nOverlay && !$isDeletePlaceHolder && isset($this->currentTable['prev'][$row['uid']])) {
// Up
$params = [];
$params['redirect'] = $this->listURL();
$params['cmd'][$table][$row['uid']]['move'] = $this->currentTable['prev'][$row['uid']];
$url = (string)$this->uriBuilder->buildUriFromRoute('tce_db', $params);
$moveUpAction = '<a class="btn btn-default" href="' . htmlspecialchars($url) . '" title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:moveUp')) . '">'
. $this->iconFactory->getIcon('actions-move-up', Icon::SIZE_SMALL)->render() . '</a>';
} else {
$moveUpAction = $this->spaceIcon;
}
$this->addActionToCellGroup($cells, $moveUpAction, 'moveUp');
if (!$isL10nOverlay && !$isDeletePlaceHolder && !empty($this->currentTable['next'][$row['uid']])) {
// Down
$params = [];
$params['redirect'] = $this->listURL();
$params['cmd'][$table][$row['uid']]['move'] = $this->currentTable['next'][$row['uid']];
$url = (string)$this->uriBuilder->buildUriFromRoute('tce_db', $params);
$moveDownAction = '<a class="btn btn-default" href="' . htmlspecialchars($url) . '" title="' . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:moveDown')) . '">'
. $this->iconFactory->getIcon('actions-move-down', Icon::SIZE_SMALL)->render() . '</a>';
} else {
$moveDownAction = $this->spaceIcon;
}
$this->addActionToCellGroup($cells, $moveDownAction, 'moveDown');
}
// "Delete" link:
$disableDelete = (bool)\trim((string)($userTsConfig['options.']['disableDelete.'][$table] ?? $userTsConfig['options.']['disableDelete'] ?? ''));
if ($permsEdit
&& !$disableDelete
&& (($table === 'pages' && $localCalcPerms->deletePagePermissionIsGranted()) || ($table !== 'pages' && $this->calcPerms->editContentPermissionIsGranted()))
&& !$this->isRecordCurrentBackendUser($table, $row)
&& !$isDeletePlaceHolder
) {
$actionName = 'delete';
$recordInfo = BackendUtility::getRecordTitle($table, $row);
if ($this->getBackendUserAuthentication()->shallDisplayDebugInformation()) {
$recordInfo .= ' [' . $table . ':' . $row['uid'] . ']';
}
$refCountMsg = BackendUtility::referenceCount(
$table,
$row['uid'],
LF . $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.referencesToRecord'),
(string)$this->getReferenceCount($table, $row['uid'])
) . BackendUtility::translationCount(
$table,
$row['uid'],
LF . $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.translationsOfRecord')
);
$warningText = sprintf($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:' . $actionName . 'Warning'), trim($recordInfo)) . $refCountMsg;
$params = 'cmd[' . $table . '][' . $row['uid'] . '][delete]=1';
$icon = $this->iconFactory->getIcon('actions-edit-' . $actionName, Icon::SIZE_SMALL)->render();
$linkTitle = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:' . $actionName));
$titleText = $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_alt_doc.xlf:label.confirm.delete_record.title');
$l10nParentField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? '';
$deleteAction = '<button type="button" class="btn btn-default t3js-record-delete"'
. ' title="' . $linkTitle . '"'
. ' aria-label="' . $linkTitle . '"'
. ' aria-haspopup="dialog"'
. ' data-button-ok-text="' . htmlspecialchars($linkTitle) . '"'
. ' data-l10parent="' . ($l10nParentField ? htmlspecialchars((string)$row[$l10nParentField]) : '') . '"'
. ' data-params="' . htmlspecialchars($params) . '"'
. ' data-message="' . htmlspecialchars($warningText) . '"'
. ' data-title="' . htmlspecialchars($titleText) . '">'
. $icon
. '</button>';
} else {
$deleteAction = $this->spaceIcon;
}
$this->addActionToCellGroup($cells, $deleteAction, 'delete');
// "Levels" links: Moving pages into new levels...
if ($permsEdit && $table === 'pages' && !$this->searchLevels) {
// Up (Paste as the page right after the current parent page)
if ($this->calcPerms->createPagePermissionIsGranted()) {
if (!$isDeletePlaceHolder && !$isL10nOverlay) {
$params = [];
$params['redirect'] = $this->listURL();
$params['cmd'][$table][$row['uid']]['move'] = -$this->id;
$url = (string)$this->uriBuilder->buildUriFromRoute('tce_db', $params);
$label = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:prevLevel'));
$moveLeftAction = '<a class="btn btn-default"'
. ' href="' . htmlspecialchars($url) . '"'
. ' title="' . $label . '"'
. ' aria-label="' . $label . '">'
. $this->iconFactory->getIcon('actions-move-left', Icon::SIZE_SMALL)->render()
. '</a>';
$this->addActionToCellGroup($cells, $moveLeftAction, 'moveLeft');
} else {
$this->addActionToCellGroup($cells, $this->spaceIcon, 'moveLeft');
}
}
// Down (Paste as subpage to the page right above)
if (!$isL10nOverlay && !$isDeletePlaceHolder && !empty($this->currentTable['prevUid'][$row['uid']])) {
$localCalcPerms = $this->getPagePermissionsForRecord(
'pages',
BackendUtility::getRecord('pages', $this->currentTable['prevUid'][$row['uid']]) ?? []
);
if ($localCalcPerms->createPagePermissionIsGranted()) {
$params = [];
$params['redirect'] = $this->listURL();
$params['cmd'][$table][$row['uid']]['move'] = $this->currentTable['prevUid'][$row['uid']];
$url = (string)$this->uriBuilder->buildUriFromRoute('tce_db', $params);
$label = htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:nextLevel'));
$moveRightAction = '<a class="btn btn-default"'
. ' href="' . htmlspecialchars($url) . '"'
. ' title="' . $label . '"'
. ' aria-label="' . $label . '">'
. $this->iconFactory->getIcon('actions-move-right', Icon::SIZE_SMALL)->render() . '</a>';
} else {
$moveRightAction = $this->spaceIcon;
}
} else {
$moveRightAction = $this->spaceIcon;
}
$this->addActionToCellGroup($cells, $moveRightAction, 'moveRight');
}
}
// Add clipboard related actions
$this->makeClip($table, $row, $cells);
$event = $this->eventDispatcher->dispatch(
new ModifyRecordListRecordActionsEvent($cells, $table, $row, $this)
);
$output = '';
foreach ($event->getActions() as $classification => $actions) {
if ($classification !== 'primary') {
$cellOutput = '';
foreach ($actions as $action) {
if ($action === $this->spaceIcon) {
continue;
}
// This is a backwards-compat layer for the existing hook items, which will be removed in TYPO3 v12.
$action = str_replace('btn btn-default', 'dropdown-item dropdown-item-spaced', $action);
$title = [];
preg_match('/title="([^"]*)"/', $action, $title);
if (empty($title)) {
preg_match('/aria-label="([^"]*)"/', $action, $title);
}
if (!empty($title[1] ?? '')) {
$action = str_replace(
[
'</a>',
'</button>',
],
[
' ' . $title[1] . '</a>',
' ' . $title[1] . '</button>',
],
$action
);
// In case we added the title as tag content, we can remove the attribute,
// since this is duplicated and would trigger a tooltip with the same content.
if (!empty($title[0] ?? '')) {
$action = str_replace($title[0], '', $action);
}
}
$cellOutput .= '<li>' . $action . '</li>';
}
if ($cellOutput !== '') {
$icon = $this->iconFactory->getIcon('actions-menu-alternative', Icon::SIZE_SMALL);
$title = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.more');
$output .= ' <div class="btn-group dropdown" title="' . htmlspecialchars($title) . '">' .
'<a href="#actions_' . $table . '_' . $row['uid'] . '" class="btn btn-default dropdown-toggle dropdown-toggle-no-chevron" data-bs-toggle="dropdown" data-bs-boundary="window" aria-expanded="false">' . $icon->render() . '</a>' .
'<ul id="actions_' . $table . '_' . $row['uid'] . '" class="dropdown-menu">' . $cellOutput . '</ul>' .
'</div>';
} else {
$output .= ' <div class="btn-group">' . $this->spaceIcon . '</div>';
}
} else {
$output .= ' <div class="btn-group">' . implode('', $actions) . '</div>';
}
}
return $output;
}
/**
* Creates the clipboard actions for a single record in the listing.
*
* @param string $table The table
* @param array $row The record for which to create the clipboard actions
* @param array $cells The already defined cells from makeControl
*/
public function makeClip(string $table, array $row, array &$cells): void
{
// Return, if disabled:
if (!$this->isClipboardFunctionalityEnabled($table, $row)) {
return;
}
$clipboardCells = [];
$isEditable = $this->isEditable($table);
if ($this->clipObj->current !== 'normal') {
$clipboardCells['copy'] = $clipboardCells['cut'] = $this->spaceIcon;
} else {
$this->addDividerToCellGroup($cells);
$isSel = $this->clipObj->isSelected($table, $row['uid']);
$copyTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.' . ($isSel === 'copy' ? 'copyrelease' : 'copy'));
$copyUrl = $this->clipObj->selUrlDB($table, (int)$row['uid'], true, $isSel === 'copy');
$clipboardCells['copy'] = '
<a class="btn btn-default" href="' . htmlspecialchars($copyUrl) . '" title="' . htmlspecialchars($copyTitle) . '" aria-label="' . htmlspecialchars($copyTitle) . '">
' . $this->iconFactory->getIcon($isSel === 'copy' ? 'actions-edit-copy-release' : 'actions-edit-copy', Icon::SIZE_SMALL)->render() . '
</a>';
// Calculate permission to cut page or content
if ($table === 'pages') {
$localCalcPerms = $this->getPagePermissionsForRecord('pages', $row);
$permsEdit = $localCalcPerms->editPagePermissionIsGranted();
} else {
$permsEdit = $this->calcPerms->editContentPermissionIsGranted() && $this->getBackendUserAuthentication()->recordEditAccessInternals($table, $row);
}
if (!$isEditable || !$this->overlayEditLockPermissions($table, $row, $permsEdit)) {
$clipboardCells['cut'] = $this->spaceIcon;
} else {
$cutTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.' . ($isSel === 'cut' ? 'cutrelease' : 'cut'));
$cutUrl = $this->clipObj->selUrlDB($table, (int)$row['uid'], false, $isSel === 'cut');
$clipboardCells['cut'] = '
<a class="btn btn-default" href="' . htmlspecialchars($cutUrl) . '" title="' . htmlspecialchars($cutTitle) . '" aria-label="' . htmlspecialchars($cutTitle) . '">
' . $this->iconFactory->getIcon($isSel === 'cut' ? 'actions-edit-cut-release' : 'actions-edit-cut', Icon::SIZE_SMALL)->render() . '
</a>';
}
}
// Now, looking for selected elements from the current table:
$elFromTable = $this->clipObj->elFromTable($table);
if (!$isEditable
|| empty($GLOBALS['TCA'][$table]['ctrl']['sortby'])
|| $this->clipObj->elFromTable($table) === []
|| !$this->overlayEditLockPermissions($table, $row)
) {
$clipboardCells['pasteAfter'] = $this->spaceIcon;
} else {
$this->addDividerToCellGroup($cells);
$pasteAfterUrl = $this->clipObj->pasteUrl($table, -$row['uid']);
$pasteAfterTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:clip_pasteAfter');
$pasteAfterContent = $this->clipObj->confirmMsgText($table, $row, 'after', $elFromTable);
$clipboardCells['pasteAfter'] = '
<button type="button" class="btn btn-default t3js-modal-trigger" data-severity="warning" aria-haspopup="dialog" title="' . htmlspecialchars($pasteAfterTitle) . '" aria-label="' . htmlspecialchars($pasteAfterTitle) . '" data-uri="' . htmlspecialchars($pasteAfterUrl) . '" data-bs-content="' . htmlspecialchars($pasteAfterContent) . '">
' . $this->iconFactory->getIcon('actions-document-paste-after', Icon::SIZE_SMALL)->render() . '
</button>';
}
// Now, looking for elements in general:
if ($table !== 'pages' || !$isEditable || $this->clipObj->elFromTable() === []) {
$clipboardCells['pasteInto'] = $this->spaceIcon;
} else {
$this->addDividerToCellGroup($cells);
$pasteIntoUrl = $this->clipObj->pasteUrl('', $row['uid']);
$pasteIntoTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:clip_pasteInto');
$pasteIntoContent = $this->clipObj->confirmMsgText($table, $row, 'into', $elFromTable);
$clipboardCells['pasteInto'] = '
<button type="button" class="btn btn-default t3js-modal-trigger" aria-haspopup="dialog" data-severity="warning" title="' . htmlspecialchars($pasteIntoTitle) . '" aria-label="' . htmlspecialchars($pasteIntoTitle) . '" data-uri="' . htmlspecialchars($pasteIntoUrl) . '" data-bs-content="' . htmlspecialchars($pasteIntoContent) . '">
' . $this->iconFactory->getIcon('actions-document-paste-into', Icon::SIZE_SMALL)->render() . '
</button>';
}
// Add the clipboard actions to the cell group
foreach ($clipboardCells as $key => $value) {
$this->addActionToCellGroup($cells, $value, $key);
}
}
/**
* Adds the checkbox to select a single record in the listing
*
* @param string $table The table
* @param array $row The record for which to make the checkbox
* @return string The checkbox for the record
*/
public function makeCheckbox(string $table, array $row): string
{
// Early return if current record is a "delete placeholder" or a translation
if ($this->isRecordDeletePlaceholder($row)
|| (int)($row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? null] ?? 0) !== 0
) {
return '';
}
// In case clipObj is not set, just add a checkbox without any clipboard functionality
if ($this->clipObj === null) {
return '
<span class="form-check form-check-type-toggle">
<input class="form-check-input t3js-multi-record-selection-check" type="checkbox" />
</span>';
}
// For the numeric clipboard pads (showing checkboxes where one can select elements on/off)
// Setting name of the element in ->CBnames array:
$identifier = $table . '|' . $row['uid'];
$this->CBnames[] = $identifier;
$isSelected = false;
// If the "duplicateField" value is set then select all elements which are duplicates...
if ($this->duplicateField && isset($row[$this->duplicateField])) {
$isSelected = in_array((string)$row[$this->duplicateField], $this->duplicateStack, true);
$this->duplicateStack[] = (string)$row[$this->duplicateField];
}
// Adding the checkbox to the panel:
return '
<span class="form-check form-check-type-toggle">
<input class="form-check-input t3js-multi-record-selection-check" type="checkbox" name="CBC[' . $identifier . ']" value="1" ' . ($isSelected ? 'checked="checked" ' : '') . '/>
</span>';
}
/**
* Creates the localization panel
*
* @param string $table The table
* @param mixed[] $row The record for which to make the localization panel.
*/
public function makeLocalizationPanel($table, $row, array $translations): string
{
$out = '';
// All records excluding pages
$possibleTranslations = $this->possibleTranslations;
if ($table === 'pages') {
// Calculate possible translations for pages
$possibleTranslations = array_map(static fn($siteLanguage) => $siteLanguage->getLanguageId(), $this->languagesAllowedForUser);
$possibleTranslations = array_filter($possibleTranslations, static fn($languageUid) => $languageUid > 0);
}
// Traverse page translations and add icon for each language that does NOT yet exist and is included in site configuration:
$pageId = (int)($table === 'pages' ? $row['uid'] : $row['pid']);
$languageInformation = $this->translateTools->getSystemLanguages($pageId);
foreach ($possibleTranslations as $lUid_OnPage) {
if ($this->isEditable($table)
&& !$this->isRecordDeletePlaceholder($row)
&& !isset($translations[$lUid_OnPage])
&& $this->getBackendUserAuthentication()->checkLanguageAccess($lUid_OnPage)
) {
$redirectUrl = (string)$this->uriBuilder->buildUriFromRoute(
'record_edit',
[
'justLocalized' => $table . ':' . $row['uid'] . ':' . $lUid_OnPage,
'returnUrl' => $this->listURL(),
]
);
$params = [];
$params['redirect'] = $redirectUrl;
$params['cmd'][$table][$row['uid']]['localize'] = $lUid_OnPage;
$href = (string)$this->uriBuilder->buildUriFromRoute('tce_db', $params);
$title = htmlspecialchars($languageInformation[$lUid_OnPage]['title'] ?? '');
$lC = ($languageInformation[$lUid_OnPage]['flagIcon'] ?? false)
? $this->iconFactory->getIcon($languageInformation[$lUid_OnPage]['flagIcon'], Icon::SIZE_SMALL)->render()
: $title;
$out .= '<a href="' . htmlspecialchars($href) . '"'
. '" class="btn btn-default t3js-action-localize"'
. ' title="' . $title . '">'
. $lC . '</a> ';
}
}
return $out;
}
/*********************************
*
* Helper functions
*
*********************************/
/**
* Creates a sort-by link on the input string ($code).
* It will automatically detect if sorting should be ascending or descending depending on $this->sortRev.
* Also some fields will not be possible to sort (including if single-table-view is disabled).
*
* @param string $label The string to link (text)
* @param string $field The fieldname represented by the title ($code)
* @param string $table Table name
* @return string Linked $code variable
*/
public function addSortLink($label, $field, $table): string
{
// Certain circumstances just return string right away (no links):
if ($this->disableSingleTableView
|| in_array($field, ['_SELECTOR', '_CONTROL_', '_LOCALIZATION_', '_REF_'], true)
) {
return $label;
}
// If "_PATH_" (showing record path) is selected, force sorting by pid field (will at least group the records!)
if ($field === '_PATH_') {
$field = 'pid';
}
// Create the sort link:
$url = $this->listURL('', $table, 'sortField,sortRev,table,pointer')
. '&sortField=' . $field . '&sortRev=' . ($this->sortRev || $this->sortField != $field ? 0 : 1);
$icon = $this->sortField === $field
? $this->iconFactory->getIcon('actions-sort-amount-' . ($this->sortRev ? 'down' : 'up'), Icon::SIZE_SMALL)->render()
: $this->iconFactory->getIcon('actions-sort-amount', Icon::SIZE_SMALL)->render();
// Return linked field:
$attributes = [
'class' => 'table-sorting-button ' . ($this->sortField === $field ? 'table-sorting-button-active' : ''),
'href' => $url,
];
return '<a ' . GeneralUtility::implodeAttributes($attributes, true) . '>
<span class="table-sorting-label">' . $label . '</span>
<span class="table-sorting-icon">' . $icon . '</span>
</a>';
}
/**
* Returns the path for a certain pid
* The result is cached internally for the session, thus you can call
* this function as much as you like without performance problems.
*
* @param int $pid The page id for which to get the path
* @return mixed[] The path.
*/
public function recPath($pid)
{
if (!isset($this->recPath_cache[$pid])) {
$this->recPath_cache[$pid] = BackendUtility::getRecordPath($pid, $this->perms_clause, 20);
}
return $this->recPath_cache[$pid];
}
/**
* Helper method around fetching the permissions of a record, by incorporating the record information AND the
* current user information.
*/
protected function getPagePermissionsForRecord(string $table, array $row): Permission
{
// If the listed table is 'pages' we have to request the permission settings for each page.
// If the listed table is not 'pages' we have to request the permission settings from the parent page
$pageId = (int)($table === 'pages' ? ($row['l10n_parent'] ?: $row['uid']) : $row['pid']);
if (!isset($this->pagePermsCache[$pageId])) {
$this->pagePermsCache[$pageId] = new Permission($this->getBackendUserAuthentication()->calcPerms(BackendUtility::getRecord('pages', $pageId)));
}
return $this->pagePermsCache[$pageId];
}
/**
* Returns TRUE if a link for creating new records should be displayed for $table
*
* @param string $table Table name
* @return bool Returns TRUE if a link for creating new records should be displayed for $table
*/
public function showNewRecLink($table)
{
// No deny/allow tables are set:
if (empty($this->allowedNewTables) && empty($this->deniedNewTables)) {
return true;
}
return !in_array($table, $this->deniedNewTables)
&& (empty($this->allowedNewTables) || in_array($table, $this->allowedNewTables));
}
/**
* add action into correct section
*
* @param array $cells
* @param string $action
* @param string $actionKey
*/
public function addActionToCellGroup(&$cells, $action, $actionKey)
{
$cellsMap = [
'primary' => [
'edit', 'hide', 'delete', 'moveUp', 'moveDown',
],
'secondary' => [
'view', 'viewBig', 'history', 'stat', 'perms', 'new', 'move', 'moveLeft', 'moveRight', 'version', 'divider', 'copy', 'cut', 'pasteAfter', 'pasteInto',
],
];
$classification = in_array($actionKey, $cellsMap['primary']) ? 'primary' : 'secondary';
$cells[$classification][$actionKey] = $action;
unset($cells[$actionKey]);
}
/**
* Check if the record represents the current backend user
*
* @param string $table
* @param array $row
* @return bool
*/
protected function isRecordCurrentBackendUser($table, $row)
{
return $table === 'be_users' && (int)($row['uid'] ?? 0) === (int)$this->getBackendUserAuthentication()->user['uid'];
}
/**
* Check if user is in workspace and given record is a delete placeholder
*/
protected function isRecordDeletePlaceholder(array $row): bool
{
return $this->getBackendUserAuthentication()->workspace > 0
&& isset($row['t3ver_state'])
&& VersionState::cast($row['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER);
}
public function setIsEditable(bool $isEditable): void
{
$this->editable = $isEditable;
}
/**
* Check if the table is readonly or editable
*/
public function isEditable(string $table): bool
{
$backendUser = $this->getBackendUserAuthentication();
return !($GLOBALS['TCA'][$table]['ctrl']['readOnly'] ?? false)
&& $this->editable
&& ($backendUser->isAdmin() || $backendUser->check('tables_modify', $table))
&& (BackendUtility::isTableWorkspaceEnabled($table) || $backendUser->workspaceAllowsLiveEditingInTable($table));
}
/**
* Check if the current record is locked by editlock. Pages are locked if their editlock flag is set,
* records are if they are locked themselves or if the page they are on is locked (a page’s editlock
* is transitive for its content elements).
*
* @param string $table
* @param array $row
* @param bool $editPermission
* @return bool
*/
protected function overlayEditLockPermissions($table, $row = [], $editPermission = true)
{
if ($editPermission && !$this->getBackendUserAuthentication()->isAdmin()) {
// If no $row is submitted we only check for general edit lock of current page (except for table "pages")
$pageHasEditLock = !empty($this->pageRow['editlock']);
if (empty($row)) {
return ($table === 'pages') || !$pageHasEditLock;
}
if (($table === 'pages' && ($row['editlock'] ?? false)) || ($table !== 'pages' && $pageHasEditLock)) {
$editPermission = false;
} elseif (isset($GLOBALS['TCA'][$table]['ctrl']['editlock']) && ($row[$GLOBALS['TCA'][$table]['ctrl']['editlock']] ?? false)) {
$editPermission = false;
}
}
return $editPermission;
}
public function setModuleData(ModuleData $moduleData): void
{
$this->moduleData = $moduleData;
}
/**
* Initializes the list generation
*
* @param int $id Page id for which the list is rendered. Must be >= 0
* @param string $table Tablename - if extended mode where only one table is listed at a time.
* @param int $pointer Browsing pointer.
* @param string $search Search word, if any
* @param int $levels Number of levels to search down the page tree
* @param int $showLimit Limit of records to be listed.
*/
public function start($id, $table, $pointer, $search = '', $levels = 0, $showLimit = 0)
{
$backendUser = $this->getBackendUserAuthentication();
// Setting internal variables:
// sets the parent id
$this->id = (int)$id;
if ($GLOBALS['TCA'][$table] ?? false) {
// Setting single table mode, if table exists:
$this->table = $table;
}
$this->page = MathUtility::forceIntegerInRange((int)$pointer, 1, 1000);
$this->showLimit = MathUtility::forceIntegerInRange((int)$showLimit, 0, 10000);
$this->searchString = trim($search);
$this->searchLevels = (int)$levels;
$this->sortField = (string)($this->request->getParsedBody()['sortField'] ?? $this->request->getQueryParams()['sortField'] ?? '');
$this->sortRev = (bool)($this->request->getParsedBody()['sortRev'] ?? $this->request->getQueryParams()['sortRev'] ?? false);
$this->duplicateField = (string)($this->request->getParsedBody()['duplicateField'] ?? $this->request->getQueryParams()['duplicateField'] ?? '');
// If there is a current link to a record, set the current link uid and get the table name from the link handler configuration
$currentLinkValue = trim($this->overrideUrlParameters['P']['currentValue'] ?? '');
if ($currentLinkValue) {
$linkService = GeneralUtility::makeInstance(LinkService::class);
try {
$currentLinkParts = $linkService->resolve($currentLinkValue);
if ($currentLinkParts['type'] === 'record' && isset($currentLinkParts['identifier'])) {
$this->currentLink['tableNames'] = $this->tableList;
$this->currentLink['uid'] = (int)$currentLinkParts['uid'];
}
} catch (UnknownLinkHandlerException $e) {
}
}
// $table might be NULL at this point in the code. As the expressionBuilder
// is used to limit returned records based on the page permissions and the
// uid field of the pages it can hardcoded to work on the pages table.
$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('pages')
->expr();
$permsClause = $expressionBuilder->and($backendUser->getPagePermsClause(Permission::PAGE_SHOW));
// This will hide records from display - it has nothing to do with user rights!!
$pidList = GeneralUtility::intExplode(',', (string)($backendUser->getTSConfig()['options.']['hideRecords.']['pages'] ?? ''), true);
if (!empty($pidList)) {
$permsClause = $permsClause->with($expressionBuilder->notIn('pages.uid', $pidList));
}
$this->perms_clause = (string)$permsClause;
$this->possibleTranslations = $this->getPossibleTranslations($this->id);
$this->setFields = $this->getBackendUserAuthentication()->getModuleData('list/displayFields') ?? [];
}
/**
* Traverses the table(s) to be listed and renders the output code for each.
*
* @return string Rendered HTML
*/
public function generateList(): string
{
$tableNames = $this->getTablesToRender();
$output = '';
foreach ($tableNames as $tableName) {
$output .= $this->getTable($tableName);
}
return $output;
}
/**
* Depending on various options returns a list of all TCA tables which should be shown
* and are allowed by the current user.
*
* @return array a list of all TCA tables
*/
protected function getTablesToRender(): array
{
$hideTablesArray = GeneralUtility::trimExplode(',', $this->hideTables);
$backendUser = $this->getBackendUserAuthentication();
// pre-process tables and add sorting instructions
$tableNames = array_flip(array_keys($GLOBALS['TCA']));
foreach ($tableNames as $tableName => $_) {
$hideTable = false;
// Checking if the table should be rendered:
// Checks that we see only permitted/requested tables:
if (($this->table && $tableName !== $this->table)
|| ($this->tableList && !GeneralUtility::inList($this->tableList, (string)$tableName))
|| !$backendUser->check('tables_select', $tableName)
) {
$hideTable = true;
}
if (!$hideTable) {
// Don't show table if hidden by TCA ctrl section
// Don't show table if hidden by page TSconfig mod.web_list.hideTables
$hideTable = !empty($GLOBALS['TCA'][$tableName]['ctrl']['hideTable'])
|| in_array($tableName, $hideTablesArray, true)
|| in_array('*', $hideTablesArray, true);
// Override previous selection if table is enabled or hidden by TSconfig TCA override mod.web_list.table
$hideTable = (bool)($this->tableTSconfigOverTCA[$tableName . '.']['hideTable'] ?? $hideTable);
}
if ($hideTable) {
unset($tableNames[$tableName]);
} else {
if (isset($this->tableDisplayOrder[$tableName])) {
// Copy display order information
$tableNames[$tableName] = $this->tableDisplayOrder[$tableName];
} else {
$tableNames[$tableName] = [];
}
}
}
try {
$orderedTableNames = GeneralUtility::makeInstance(DependencyOrderingService::class)
->orderByDependencies($tableNames);
} catch (\UnexpectedValueException $e) {
// If you have circular dependencies we just keep the original order and give a notice
// Example mod.web_list.tableDisplayOrder.pages.after = tt_content
$lang = $this->getLanguageService();
$header = $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:warning.tableDisplayOrder.title');
$msg = $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:warning.tableDisplayOrder.message');
$flashMessage = GeneralUtility::makeInstance(FlashMessage::class, $msg, $header, ContextualFeedbackSeverity::WARNING, true);
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
$orderedTableNames = $tableNames;
}
return array_keys($orderedTableNames);
}
/**
* Returns a QueryBuilder configured to select $fields from $table where the pid is restricted
* depending on the current searchlevel setting.
*
* @param string $table Table name
* @param string[] $fields Field list to select, * for all
*/
public function getQueryBuilder(
string $table,
array $fields = ['*'],
bool $addSorting = true,
int $firstResult = 0,
int $maxResult = 0
): QueryBuilder {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable($table);
$queryBuilder->getRestrictions()
->removeAll()
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->getBackendUserAuthentication()->workspace));
$queryBuilder
->select(...$fields)
->from($table);
// Additional constraints
if (($GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? false)
&& ($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? false)) {
// Only restrict to the default language if no search request is in place
// And if only translations should be shown
if ($this->searchString === '' && !$this->showOnlyTranslatedRecords) {
$queryBuilder->andWhere(
$queryBuilder->expr()->or(
$queryBuilder->expr()->lte($GLOBALS['TCA'][$table]['ctrl']['languageField'], 0),
$queryBuilder->expr()->eq($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'], 0)
)
);
}
}
if ($table === 'pages' && $this->showOnlyTranslatedRecords) {
$queryBuilder->andWhere(
$queryBuilder->expr()->in(
$GLOBALS['TCA']['pages']['ctrl']['languageField'],
array_keys($this->languagesAllowedForUser)
)
);
}
// Former prepareQueryBuilder
if ($maxResult > 0) {
$queryBuilder->setMaxResults($maxResult);
}
if ($firstResult > 0) {
$queryBuilder->setFirstResult($firstResult);
}
if ($addSorting) {
if ($this->sortField && in_array($this->sortField, BackendUtility::getAllowedFieldsForTable($table, false))) {
$queryBuilder->orderBy($this->sortField, $this->sortRev ? 'DESC' : 'ASC');
} else {
$orderBy = ($GLOBALS['TCA'][$table]['ctrl']['sortby'] ?? '') ?: $GLOBALS['TCA'][$table]['ctrl']['default_sortby'] ?? '';
$orderBys = QueryHelper::parseOrderBy($orderBy);
foreach ($orderBys as $orderBy) {
$queryBuilder->addOrderBy($orderBy[0], $orderBy[1]);
}
}
}
// Build the query constraints
$queryBuilder = $this->addPageIdConstraint($table, $queryBuilder, $this->searchLevels);
$searchWhere = $this->makeSearchString($table, $this->id, $queryBuilder);
if (!empty($searchWhere)) {
$queryBuilder->andWhere($searchWhere);
}
// Filtering on displayable pages (permissions):
if ($table === 'pages' && $this->perms_clause) {
$queryBuilder->andWhere($this->perms_clause);
}
// Filter out records that are translated, if TSconfig mod.web_list.hideTranslations is set
if (!empty($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
&& (GeneralUtility::inList($this->hideTranslations, $table) || $this->hideTranslations === '*')
) {
$queryBuilder->andWhere(
$queryBuilder->expr()->eq(
$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'],
0
)
);
} elseif (!empty($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']) && $this->showOnlyTranslatedRecords) {
// When only translated records should be shown, it is necessary to use l10n_parent=pageId, instead of
// a check to the PID
$queryBuilder->andWhere(
$queryBuilder->expr()->eq(
$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'],
$queryBuilder->createNamedParameter(
$this->id,
Connection::PARAM_INT
)
)
);
}
$event = new ModifyDatabaseQueryForRecordListingEvent(
$queryBuilder,
$table,
$this->id,
$fields,
$firstResult,
$maxResult,
$this
);
$this->eventDispatcher->dispatch($event);
return $event->getQueryBuilder();
}
/**
* Creates part of query for searching after a word ($this->searchString)
* fields in input table.
*
* @param string $table Table, in which the fields are being searched.
* @param int $currentPid Page id for the possible search limit
* @return string Returns part of WHERE-clause for searching, if applicable.
*/
protected function makeSearchString(string $table, int $currentPid, QueryBuilder $queryBuilder)
{
$expressionBuilder = $queryBuilder->expr();
$constraints = [];
$tablePidField = $table === 'pages' ? 'uid' : 'pid';
// Make query only if table is valid and a search string is actually defined
if (empty($this->searchString)) {
return '';
}
$searchableFields = [];
// Get fields from ctrl section of TCA first
if (isset($GLOBALS['TCA'][$table]['ctrl']['searchFields'])) {
$searchableFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['searchFields'], true);
}
if (MathUtility::canBeInterpretedAsInteger($this->searchString)) {
$constraints[] = $expressionBuilder->eq('uid', (int)$this->searchString);
foreach ($searchableFields as $fieldName) {
if (!isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
continue;
}
$fieldConfig = $GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
$fieldType = $fieldConfig['type'];
if (($fieldType === 'number' && ($fieldConfig['format'] ?? 'integer') === 'integer')
|| ($fieldType === 'datetime' && !in_array($fieldConfig['dbType'] ?? '', QueryHelper::getDateTimeTypes(), true))
) {
if (!isset($fieldConfig['search']['pidonly'])
|| ($fieldConfig['search']['pidonly'] && $currentPid > 0)
) {
$constraints[] = $expressionBuilder->and(
$expressionBuilder->eq($fieldName, (int)$this->searchString),
$expressionBuilder->eq($tablePidField, (int)$currentPid)
);
}
} elseif ($this->isTextFieldType($fieldType)) {
$constraints[] = $expressionBuilder->like(
$fieldName,
$queryBuilder->quote('%' . (int)$this->searchString . '%')
);
}
}
} elseif (!empty($searchableFields)) {
$like = $queryBuilder->quote('%' . $queryBuilder->escapeLikeWildcards($this->searchString) . '%');
foreach ($searchableFields as $fieldName) {
if (!isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
continue;
}
$fieldConfig = $GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
$fieldType = $fieldConfig['type'];
$searchConstraint = $expressionBuilder->and(
$expressionBuilder->comparison(
'LOWER(' . $queryBuilder->castFieldToTextType($fieldName) . ')',
'LIKE',
'LOWER(' . $like . ')'
)
);
if (is_array($fieldConfig['search'] ?? null)) {
$searchConfig = $fieldConfig['search'];
if ($searchConfig['case'] ?? false) {
// Replace case insensitive default constraint
$searchConstraint = $expressionBuilder->and($expressionBuilder->like($fieldName, $like));
}
if (($searchConfig['pidonly'] ?? false) && $currentPid > 0) {
$searchConstraint = $searchConstraint->with($expressionBuilder->eq($tablePidField, (int)$currentPid));
}
if ($searchConfig['andWhere'] ?? false) {
$searchConstraint = $searchConstraint->with(
QueryHelper::quoteDatabaseIdentifiers($queryBuilder->getConnection(), QueryHelper::stripLogicalOperatorPrefix($fieldConfig['search']['andWhere']))
);
}
}
if ($this->isTextFieldType($fieldType) && $searchConstraint->count() !== 0) {
$constraints[] = $searchConstraint;
}
}
}
// If no search field conditions have been built ensure no results are returned
if (empty($constraints)) {
return '0=1';
}
return $expressionBuilder->or(...$constraints);
}
/**
* Returns the title (based on $label) of a table ($table) with the proper link around. For headers over tables.
* The link will cause the display of all extended mode or not for the table.
*
* @param string $table Table name
* @param string $label Table label
* @return string The linked table label
*/
public function linkWrapTable(string $table, string $label): string
{
if ($this->table !== $table) {
$url = $this->listURL('', $table, 'pointer');
} else {
$url = $this->listURL('', '', 'sortField,sortRev,table,pointer');
}
return '<a href="' . htmlspecialchars($url) . '">' . $label . '</a>';
}
/**
* Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for 'pages'-records a link to the level of that record...)
*
* @param string $table Table name
* @param int $uid Item uid
* @param string $code Item title (not htmlspecialchars()'ed yet)
* @param mixed[] $row Item row
* @return string The item title. Ready for HTML output (is htmlspecialchars()'ed)
*/
public function linkWrapItems($table, $uid, $code, $row)
{
$lang = $this->getLanguageService();
$origCode = $code;
// If the title is blank, make a "no title" label:
if ((string)$code === '') {
$code = '<i>[' . htmlspecialchars(
$lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.no_title')
) . ']</i> - '
. htmlspecialchars(BackendUtility::getRecordTitle($table, $row));
} else {
$code = htmlspecialchars($code);
}
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 = $this->getPagePermissionsForRecord('pages', $row);
$permsEdit = $localCalcPerms->editPagePermissionIsGranted();
} else {
$backendUser = $this->getBackendUserAuthentication();
$permsEdit = $this->calcPerms->editContentPermissionIsGranted() && $backendUser->recordEditAccessInternals($table, $row);
}
// "Edit" link: ( Only if permissions to edit the page-record of the content of the parent page ($this->id)
if ($permsEdit && $this->isEditable($table)) {
$params = [
'edit' => [
$table => [
$row['uid'] => 'edit',
],
],
'returnUrl' => $this->listURL(),
];
$editLink = $this->uriBuilder->buildUriFromRoute('record_edit', $params);
$label = htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:edit'));
$code = '<a href="' . htmlspecialchars($editLink) . '"'
. ' title="' . $label . '"'
. ' aria-label="' . $label . '">'
. $code . '</a>';
}
break;
case 'show':
// "Show" link (only pages and tt_content elements)
if (($table === 'pages' || $table === 'tt_content')
&& ($attributes = $this->getPreviewUriBuilder($table, $row)->serializeDispatcherAttributes()) !== null
) {
$title = htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.showPage'));
$code = '<button ' . $attributes
. ' title="' . $title . '"'
. ' aria-label="' . $title . '">'
. $code . '</button>';
}
break;
case 'info':
// "Info": (All records)
$label = htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:showInfo'));
$code = '<a href="#" role="button"' // @todo add handler that triggers click on space key
. $this->createShowItemTagAttributes($table . ',' . (int)$row['uid'])
. ' title="' . $label . '"'
. ' aria-label="' . $label . '"'
. ' aria-haspopup="dialog">'
. $code
. '</a>';
break;
default:
// Output the label now:
if ($table === 'pages') {
$code = '<a href="' . htmlspecialchars(
$this->listURL((string)$uid, '', 'pointer')
) . '">' . $code . '</a>';
} else {
$code = $this->linkUrlMail($code, $origCode);
}
}
return $code;
}
/**
* Wrapping input code in link to URL or email if $testString is either.
*
* @param string $code code to wrap
* @param string $testString String which is tested for being a URL or email and which will be used for the link if so.
* @return string Link-Wrapped $code value, if $testString was URL or email.
*/
protected function linkUrlMail(string $code, string $testString): string
{
// Check for URL:
$scheme = parse_url($testString, PHP_URL_SCHEME);
if ($scheme === 'http' || $scheme === 'https' || $scheme === 'ftp') {
return '<a href="' . htmlspecialchars($testString) . '" target="_blank">' . $code . '</a>';
}
// Check for email:
if (GeneralUtility::validEmail($testString)) {
return '<a href="mailto:' . htmlspecialchars($testString) . '" target="_blank">' . $code . '</a>';
}
// Return if nothing else...
return $code;
}
/**
* Creates the URL to this script, including all relevant GPvars
* Fixed GPvars are id, table, returnUrl, searchTerm, and search_levels
* The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.
*
* @param string $altId Alternative id value. Enter blank string for the current id ($this->id)
* @param string $table Table name to display. Enter "-1" for the current table.
* @param string $exclList Comma separated list of fields NOT to include ("sortField", "sortRev" or "pointer")
* @return string URL
*/
public function listURL($altId = '', $table = '-1', $exclList = '')
{
$urlParameters = [];
if ((string)$altId !== '') {
$urlParameters['id'] = $altId;
} else {
$urlParameters['id'] = $this->id;
}
if ($table === '-1') {
$urlParameters['table'] = $this->table;
} else {
$urlParameters['table'] = $table;
}
if ($this->returnUrl) {
$urlParameters['returnUrl'] = $this->returnUrl;
}
if ((!$exclList || !GeneralUtility::inList($exclList, 'searchTerm')) && $this->searchString) {
$urlParameters['searchTerm'] = $this->searchString;
}
if ($this->searchLevels) {
$urlParameters['search_levels'] = $this->searchLevels;
}
if ((!$exclList || !GeneralUtility::inList($exclList, 'pointer')) && $this->page) {
$urlParameters['pointer'] = $this->page;
}
if ((!$exclList || !GeneralUtility::inList($exclList, 'sortField')) && $this->sortField) {
$urlParameters['sortField'] = $this->sortField;
}
if ((!$exclList || !GeneralUtility::inList($exclList, 'sortRev')) && $this->sortRev) {
$urlParameters['sortRev'] = $this->sortRev;
}
return (string)$this->uriBuilder->buildUriFromRoute(
$this->request->getAttribute('route')->getOption('_identifier'),
array_replace($urlParameters, $this->overrideUrlParameters)
);
}
/**
* Set URL parameters to override or add in the listUrl() method.
*
* @param string[] $urlParameters
*/
public function setOverrideUrlParameters(array $urlParameters, ServerRequestInterface $request)
{
$currentUrlParameter = $request->getParsedBody()['curUrl'] ?? $request->getQueryParams()['curUrl'] ?? '';
if (isset($currentUrlParameter['url'])) {
$urlParameters['P']['currentValue'] = $currentUrlParameter['url'];
}
$this->overrideUrlParameters = $urlParameters;
}
/**
* Set table display order information
*
* Structure of $orderInformation:
* 'tableName' => [
* 'before' => // comma-separated string list or array of table names
* 'after' => // comma-separated string list or array of table names
* ]
*
* @param array $orderInformation
* @throws \UnexpectedValueException
*/
public function setTableDisplayOrder(array $orderInformation)
{
foreach ($orderInformation as $tableName => &$configuration) {
if (isset($configuration['before'])) {
if (is_string($configuration['before'])) {
$configuration['before'] = GeneralUtility::trimExplode(',', $configuration['before'], true);
} elseif (!is_array($configuration['before'])) {
throw new \UnexpectedValueException(
'The specified "before" order configuration for table "' . $tableName . '" is invalid.',
1504793406
);
}
}
if (isset($configuration['after'])) {
if (is_string($configuration['after'])) {
$configuration['after'] = GeneralUtility::trimExplode(',', $configuration['after'], true);
} elseif (!is_array($configuration['after'])) {
throw new \UnexpectedValueException(
'The specified "after" order configuration for table "' . $tableName . '" is invalid.',
1504793407
);
}
}
}
$this->tableDisplayOrder = $orderInformation;
}
public function getOverridePageIdList(): array
{
return $this->overridePageIdList;
}
/**
* @param int[]|array $overridePageIdList
*/
public function setOverridePageIdList(array $overridePageIdList)
{
$this->overridePageIdList = array_map('intval', $overridePageIdList);
}
/**
* Get all allowed mount pages to be searched in.
*
* @param int $id Page id
* @param int $depth Depth to go down
* @return int[]
*/
protected function getSearchableWebmounts(int $id, int $depth): array
{
$runtimeCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('runtime');
$hash = 'webmounts_list' . md5($id . '-' . $depth . '-' . $this->perms_clause);
$idList = $runtimeCache->get($hash);
if ($idList === false) {
$backendUser = $this->getBackendUserAuthentication();
if (!$backendUser->isAdmin() && $id === 0) {
$mountPoints = array_map('intval', $backendUser->returnWebmounts());
$mountPoints = array_unique($mountPoints);
} else {
$mountPoints = [$id];
}
// Add the initial mount points to the pids
$idList = $mountPoints;
$repository = GeneralUtility::makeInstance(PageTreeRepository::class);
$repository->setAdditionalWhereClause($this->perms_clause);
$pages = $repository->getFlattenedPages($mountPoints, $depth);
foreach ($pages as $page) {
$idList[] = (int)$page['uid'];
}
$idList = array_unique($idList);
$runtimeCache->set($hash, $idList);
}
return $idList;
}
/**
* Add conditions to the QueryBuilder object ($queryBuilder) to limit a
* query to a list of page IDs based on the current search level setting.
*
* @return QueryBuilder Modified QueryBuilder object
*/
protected function addPageIdConstraint(string $tableName, QueryBuilder $queryBuilder, int $searchLevels): QueryBuilder
{
// Set search levels to 999 instead of -1 as the following methods
// do not support -1 as valid value for infinite search.
if ($searchLevels === -1) {
$searchLevels = 999;
}
// When querying translated pages, the PID of the translated pages should be the same as the
// the PID of the current page
if ($tableName === 'pages' && $this->showOnlyTranslatedRecords) {
$pageRecord = BackendUtility::getRecordWSOL('pages', $this->id);
$queryBuilder->andWhere(
$queryBuilder->expr()->eq(
$tableName . '.pid',
$queryBuilder->createNamedParameter($pageRecord['pid'] ?? 0, Connection::PARAM_INT)
)
);
} elseif ($searchLevels === 0) {
$queryBuilder->andWhere(
$queryBuilder->expr()->eq(
$tableName . '.pid',
$queryBuilder->createNamedParameter($this->id, Connection::PARAM_INT)
)
);
} elseif ($searchLevels > 0) {
$allowedMounts = $this->getSearchableWebmounts($this->id, $searchLevels);
$queryBuilder->andWhere(
$queryBuilder->expr()->in(
$tableName . '.pid',
$queryBuilder->createNamedParameter($allowedMounts, Connection::PARAM_INT_ARRAY)
)
);
}
if (!empty($this->getOverridePageIdList())) {
$queryBuilder->andWhere(
$queryBuilder->expr()->in(
$tableName . '.pid',
$queryBuilder->createNamedParameter($this->getOverridePageIdList(), Connection::PARAM_INT_ARRAY)
)
);
}
return $queryBuilder;
}
protected function getBackendUserAuthentication(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
/**
* Returns a table-row with the content from the fields in the input data array.
* OBS: $this->fieldArray MUST be set! (represents the list of fields to display)
*
* @param array $data Is the data array, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in <td>-tags
* @param string $rowParams Is insert in the <tr>-tags. Must carry a ' ' as first character
* @param string $colType Defines the tag being used for the columns. Default is td.
*
* @return string HTML content for the table row
*/
protected function addElement($data, $rowParams = '', $colType = 'td')
{
$colType = ($colType === 'th') ? 'th' : 'td';
$dataUid = ($colType === 'td') ? ($data['uid'] ?? 0) : 0;
$l10nParent = $data['_l10nparent_'] ?? 0;
$out = '<tr ' . $rowParams . ' data-uid="' . $dataUid . '" data-l10nparent="' . $l10nParent . '" data-multi-record-selection-element="true">';
// Init rendering.
$colsp = '';
$lastKey = '';
$c = 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' && isset($data['__label'])) {
// The title label column does always follow the icon column. Since
// in some cases the first column - "_SELECTOR_" - might not be rendered,
// we always have to calculate the key by searching for the icon column.
$titleLabelKey = (int)(array_search('icon', $fields, true)) + 1;
$fields[$titleLabelKey] = '__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] ?? '';
$out .= '
<' . $colType . ' class="' . $cssClass . ' nowrap' . '"' . $colsp . '>' . $data[$lastKey] . '</' . $colType . '>';
}
$lastKey = $vKey;
$c = 1;
} else {
if (!$lastKey) {
$lastKey = $vKey;
}
$c++;
}
if ($c > 1) {
$colsp = ' colspan="' . $c . '"';
} else {
$colsp = '';
}
}
if ($lastKey) {
$cssClass = $this->addElement_tdCssClass[$lastKey] ?? '';
$out .= '
<' . $colType . ' class="' . $cssClass . ' nowrap' . '"' . $colsp . '>' . $data[$lastKey] . '</' . $colType . '>';
}
// End row
$out .= '
</tr>';
return $out;
}
/**
* Fetches all possible translations for the given page
*
* This depends on the site config and the current translations of the page record
* It is used to set the possible translations for all records excluding pages
*
* @param int $pageUid
* @return int[]
*/
protected function getPossibleTranslations(int $pageUid): array
{
// Store languages that are included in the site configuration for the current page.
$availableSystemLanguageUids = array_keys($this->translateTools->getSystemLanguages($pageUid));
if ($availableSystemLanguageUids === []) {
return [];
}
// 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(WorkspaceRestriction::class, $this->getBackendUserAuthentication()->workspace));
$result = $queryBuilder
->select('*')
->from('pages')
->where(
$queryBuilder->expr()->and(
$queryBuilder->expr()->eq($localizationParentField, $queryBuilder->createNamedParameter($pageUid, Connection::PARAM_INT)),
$queryBuilder->expr()->in($languageField, $queryBuilder->createNamedParameter($availableSystemLanguageUids, Connection::PARAM_INT_ARRAY)),
$queryBuilder->expr()->gt(
$languageField,
$queryBuilder->createNamedParameter(0, Connection::PARAM_INT)
)
)
)
->executeQuery();
$allowedTranslationsOnPage = [];
while ($row = $result->fetchAssociative()) {
$allowedTranslationsOnPage[] = (int)$row[$languageField];
}
return $allowedTranslationsOnPage;
}
/**
* Return the icon for the language
*
* @return string Language icon
*/
protected function languageFlag(string $table, array $row): string
{
$pageId = (int)($table === 'pages' ? ($row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] ?: $row['uid']) : $row['pid']);
$languageUid = (int)($row[$GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? null] ?? 0);
$languageInformation = $this->translateTools->getSystemLanguages($pageId);
$title = htmlspecialchars($languageInformation[$languageUid]['title'] ?? '');
$indent = $this->isLocalized($table, $row) ? '<span class="indent indent-inline-block" style="--indent-level: 1"></span> ' : '';
if ($languageInformation[$languageUid]['flagIcon'] ?? false) {
return $indent . $this->iconFactory
->getIcon($languageInformation[$languageUid]['flagIcon'], Icon::SIZE_SMALL)
->setTitle($title)
->render() . ' ' . $title;
}
return $title;
}
/**
* Generates HTML code for a Reference tooltip out of
* sys_refindex records you hand over
*/
protected function generateReferenceToolTip(string $table, int $uid): string
{
$numberOfReferences = $this->getReferenceCount($table, $uid);
if (!$numberOfReferences) {
$htmlCode = '<button type="button" class="btn btn-default" disabled><span style="display:inline-block;min-width:16px">-</span></button>';
} else {
$showReferences = $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang.xlf:show_references');
$htmlCode = '<button type="button"'
. ' class="btn btn-default"'
. ' aria-haspopup="dialog"'
. ' ' . $this->createShowItemTagAttributes($table . ',' . $uid)
. ' title="' . htmlspecialchars($showReferences) . ' (' . $numberOfReferences . ')' . '">'
. '<span style="display:inline-block;min-width:16px">'
. $numberOfReferences
. '<span class="visually-hidden">' . $showReferences . '</span>'
. '</span>'
. '</button>';
}
return $htmlCode;
}
/**
* Render convenience actions, such as "check all"
*
* @return string HTML markup for the checkbox actions
*/
protected function renderCheckboxActions(): string
{
$lang = $this->getLanguageService();
$dropdownItems['checkAll'] = '
<li>
<button type="button" class="dropdown-item disabled" data-multi-record-selection-check-action="check-all" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.checkAll')) . '">
' . $this->iconFactory->getIcon('actions-selection-elements-all', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.checkAll')) . '
</button>
</li>';
$dropdownItems['checkNone'] = '
<li>
<button type="button" class="dropdown-item disabled" data-multi-record-selection-check-action="check-none" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.uncheckAll')) . '">
' . $this->iconFactory->getIcon('actions-selection-elements-none', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.uncheckAll')) . '
</button>
</li>';
$dropdownItems['toggleSelection'] = '
<li>
<button type="button" class="dropdown-item disabled" data-multi-record-selection-check-action="toggle" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.toggleSelection')) . '">
' . $this->iconFactory->getIcon('actions-selection-elements-invert', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.toggleSelection')) . '
</button>
</li>';
return '
<div class="btn-group dropdown">
<button type="button" class="dropdown-toggle dropdown-toggle-link t3js-multi-record-selection-check-actions-toggle" data-bs-toggle="dropdown" data-bs-boundary="window" aria-expanded="false">
' . $this->iconFactory->getIcon('actions-selection', Icon::SIZE_SMALL) . '
</button>
<ul class="dropdown-menu t3js-multi-record-selection-check-actions">
' . implode(PHP_EOL, $dropdownItems) . '
</ul>
</div>';
}
/**
* Render the multi record selection actions, which are shown as soon as one record is selected
*/
protected function renderMultiRecordSelectionActions(string $table, array $currentIdList): string
{
$actions = [];
$lang = $this->getLanguageService();
$userTsConfig = $this->getBackendUserAuthentication()->getTSConfig();
$addClipboardActions = $this->showClipboardActions && $this->isClipboardFunctionalityEnabled($table);
$editPermission = (
($table === 'pages') ? $this->calcPerms->editPagePermissionIsGranted() : $this->calcPerms->editContentPermissionIsGranted()
) && $this->overlayEditLockPermissions($table);
// Add actions in case table can be modified by the current user
if ($editPermission && $this->isEditable($table)) {
$editActionConfiguration = GeneralUtility::jsonEncodeForHtmlAttribute([
'idField' => 'uid',
'tableName' => $table,
'returnUrl' => $this->listURL(),
], true);
$actions['edit'] = '
<button
type="button"
title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.edit')) . '"
class="btn btn-sm btn-default"
data-multi-record-selection-action="edit"
data-multi-record-selection-action-config="' . $editActionConfiguration . '"
>
' . $this->iconFactory->getIcon('actions-document-open', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.edit')) . '
</button>';
if (!(bool)trim((string)($userTsConfig['options.']['disableDelete.'][$table] ?? $userTsConfig['options.']['disableDelete'] ?? ''))) {
$deleteActionConfiguration = GeneralUtility::jsonEncodeForHtmlAttribute([
'idField' => 'uid',
'ok' => $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.delete'),
'title' => $lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:clip_deleteMarked'),
'content' => sprintf($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:clip_deleteMarkedWarning'), $lang->sL($GLOBALS['TCA'][$table]['ctrl']['title'])),
], true);
$actions['delete'] = '
<button
type="button"
title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.delete')) . '"
class="btn btn-sm btn-default"
data-multi-record-selection-action="delete"
data-multi-record-selection-action-config="' . $deleteActionConfiguration . '"
aria-haspopup="dialog"
>
' . $this->iconFactory->getIcon('actions-edit-delete', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.delete')) . '
</button>';
}
}
// Add clipboard actions in case they are enabled and clipboard is not deactivated
if ($addClipboardActions && (string)($this->modTSconfig['enableClipBoard'] ?? '') !== 'deactivated') {
$copyMarked = '
<button type="button"
class="btn btn-sm btn-default ' . ($this->clipObj->current === 'normal' ? 'disabled' : '') . '"
title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.transferToClipboard')) . '"
data-multi-record-selection-action="copyMarked"
>
' . $this->iconFactory->getIcon('actions-edit-copy', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.transferToClipboard')) . '
</button>';
$removeMarked = '
<button type="button"
class="btn btn-sm btn-default ' . ($this->clipObj->current === 'normal' ? 'disabled' : '') . '"
title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.removeFromClipboard')) . '"
data-multi-record-selection-action="removeMarked"
>
' . $this->iconFactory->getIcon('actions-minus', Icon::SIZE_SMALL)->render() . '
' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:cm.removeFromClipboard')) . '
</button>';
// Add "copy marked" after "edit", or in case "edit" is not set, as first item
if (!isset($actions['edit'])) {
$actions = array_merge(['copyMarked' => $copyMarked], $actions);
} else {
$end = array_splice($actions, (int)(array_search('edit', array_keys($actions), true)) + 1);
$actions = array_merge($actions, ['copyMarked' => $copyMarked, 'removeMarked' => $removeMarked], $end);
}
}
$event = $this->eventDispatcher->dispatch(
new ModifyRecordListTableActionsEvent($actions, $table, $currentIdList, $this)
);
/** @var array<string, string> $actions */
$actions = $event->getActions();
if ($actions === []) {
// In case the user does not have permissions to execute on of the above
// actions or a hook removed all remaining actions, inform the user about this.
return '
<span class="badge badge-info">
' . htmlspecialchars($lang->sL($event->getNoActionLabel() ?: 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.noActionAvailable')) . '
</span>
';
}
return implode(LF, $actions);
}
/**
* If enabled, only translations are shown (= only with l10n_parent)
* See the use case in RecordList class, where a list of page translations is rendered before.
*/
public function showOnlyTranslatedRecords(bool $showOnlyTranslatedRecords)
{
$this->showOnlyTranslatedRecords = $showOnlyTranslatedRecords;
}
/**
* Creates data attributes to be handles in moddule `TYPO3/CMS/Backend/ActionDispatcher`
*/
protected function createShowItemTagAttributes(string $arguments): string
{
return GeneralUtility::implodeAttributes([
'data-dispatch-action' => 'TYPO3.InfoWindow.showItem',
'data-dispatch-args-list' => $arguments,
], true);
}
protected function getLanguageService(): LanguageService
{
return $GLOBALS['LANG'];
}
public function setLanguagesAllowedForUser(array $languagesAllowedForUser): DatabaseRecordList
{
$this->languagesAllowedForUser = $languagesAllowedForUser;
return $this;
}
/**
* Check if a given record is a localization
*/
protected function isLocalized(string $table, array $row): bool
{
$languageField = $GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? '';
$transOrigPointerField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? '';
return ($row[$languageField] ?? false) && ($row[$transOrigPointerField] ?? false);
}
/**
* Returns the configuration of mod.web_list.noViewWithDokTypes or the
* default value 254 (Sys Folders) and 255 (Recycler), if not set.
*/
protected function getNoViewWithDokTypes(array $tsConfig): array
{
if (isset($tsConfig['noViewWithDokTypes'])) {
$noViewDokTypes = GeneralUtility::intExplode(',', (string)$tsConfig['noViewWithDokTypes'], true);
} else {
$noViewDokTypes = [
PageRepository::DOKTYPE_SPACER,
PageRepository::DOKTYPE_SYSFOLDER,
PageRepository::DOKTYPE_RECYCLER,
];
}
return $noViewDokTypes;
}
/**
* Check whether the clipboard functionality is generally enabled.
* In case a row is given, this checks if the record is neither
* a "delete placeholder", nor a translation, nor a version
*/
protected function isClipboardFunctionalityEnabled(string $table, array $row = []): bool
{
return $this->clipObj !== null
&& ($table !== 'pages' || !$this->showOnlyTranslatedRecords)
&& (
$row === []
|| (
!$this->isRecordDeletePlaceholder($row)
&& (int)($row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] ?? null] ?? 0) === 0
)
)
&& (BackendUtility::isTableWorkspaceEnabled($table) || $this->getBackendUserAuthentication()->workspaceAllowsLiveEditingInTable($table));
}
/**
* Add a divider to the secondary cell group, if not already present
*/
protected function addDividerToCellGroup(array &$cells): void
{
if (!($cells['secondary']['divider'] ?? false)) {
$this->addActionToCellGroup($cells, '<hr class="dropdown-divider">', 'divider');
}
}
protected function isTextFieldType(string $fieldType): bool
{
$textFieldTypes = [
'input',
'text',
'json',
'flex',
'email',
'link',
'slug',
'color',
'uuid',
];
return in_array($fieldType, $textFieldTypes, true);
}
}