GridColumnItem.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Backend\View\BackendLayout\Grid;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Backend\Preview\StandardPreviewRendererResolver;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Backend\View\Event\PageContentPreviewRenderingEvent;
use ‪TYPO3\CMS\Backend\View\PageLayoutContext;
use ‪TYPO3\CMS\Core\Database\ReferenceIndex;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪GridColumnItem extends ‪AbstractGridObject
{
    protected array ‪$translations = [];
 
    public function ‪__construct(
        ‪PageLayoutContext $context,
        protected readonly ‪GridColumn $column,
        protected array ‪$record,
        protected readonly string $table = 'tt_content'
    ) {
        parent::__construct($context);
    }
 
    public function ‪isVersioned(): bool
    {
        return ($this->record['_ORIG_uid'] ?? 0) > 0 || (int)($this->record['t3ver_state'] ?? 0) !== 0;
    }
 
    public function ‪getPreview(): string
    {
        $previewRenderer = GeneralUtility::makeInstance(StandardPreviewRendererResolver::class)
            ->resolveRendererFor(
                $this->table,
                $this->record,
                $this->context->getPageId()
            );
        $previewHeader = $previewRenderer->renderPageModulePreviewHeader($this);
 
        // Dispatch event to allow listeners adding an alternative content type
        // specific preview or to manipulate the content elements' record data.
        $event = GeneralUtility::makeInstance(EventDispatcherInterface::class)->dispatch(
            new ‪PageContentPreviewRenderingEvent($this->table, $this->record, $this->context)
        );
 
        // Update the modified record data
        $this->record = $event->getRecord();
 
        // Get specific preview from listeners. In case non was added,
        // fall back to the standard preview rendering workflow.
        $previewContent = $event->getPreviewContent();
        if ($previewContent === null) {
            $previewContent = $previewRenderer->renderPageModulePreviewContent($this);
        }
 
        return $previewRenderer->wrapPageModulePreview($previewHeader, $previewContent, $this);
    }
 
    public function ‪getWrapperClassName(): string
    {
        $wrapperClassNames = [];
        if ($this->‪isDisabled()) {
            $wrapperClassNames[] = 't3-page-ce-hidden t3js-hidden-record';
        }
        if ($this->‪isInconsistentLanguage()) {
            $wrapperClassNames[] = 't3-page-ce-warning';
        }
 
        return implode(' ', $wrapperClassNames);
    }
 
    public function ‪isDelible(): bool
    {
        $backendUser = $this->‪getBackendUser();
        if (!$backendUser->doesUserHaveAccess($this->context->getPageRecord(), ‪Permission::CONTENT_EDIT)) {
            return false;
        }
        return !($backendUser->getTSConfig()['options.']['disableDelete.'][$this->table] ?? $backendUser->getTSConfig()['options.']['disableDelete'] ?? false);
    }
 
    public function ‪getDeleteUrl(): string
    {
        return (string)GeneralUtility::makeInstance(UriBuilder::class)->buildUriFromRoute(
            'tce_db',
            [
                'cmd' => [
                    $this->table => [
                        $this->record['uid'] => [
                            'delete' => 1,
                        ],
                    ],
                ],
                'redirect' => $this->context->getCurrentRequest()->getAttribute('normalizedParams')->getRequestUri(),
            ]
        );
    }
 
    public function ‪getDeleteMessage(): string
    {
        $recordInfo = ‪GeneralUtility::fixed_lgd_cs(BackendUtility::getRecordTitle($this->table, $this->record), (int)$this->‪getBackendUser()->uc['titleLen']);
        if ($this->‪getBackendUser()->shallDisplayDebugInformation()) {
            $recordInfo .= ' [' . $this->table . ':' . $this->record['uid'] . ']';
        }
 
        $refCountMsg = BackendUtility::referenceCount(
            $this->table,
            $this->record['uid'],
            LF . $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.referencesToRecord'),
            (string)$this->‪getReferenceCount($this->record['uid'])
        ) . BackendUtility::translationCount(
            $this->table,
            $this->record['uid'],
            LF . $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.translationsOfRecord')
        );
 
        return sprintf($this->‪getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:deleteWarning'), trim($recordInfo)) . $refCountMsg;
    }
 
    public function ‪getFooterInfo(): string
    {
        ‪$record = $this->‪getRecord();
        $previewRenderer = GeneralUtility::makeInstance(StandardPreviewRendererResolver::class)
            ->resolveRendererFor(
                $this->table,
                ‪$record,
                $this->context->getPageId()
            );
        return $previewRenderer->renderPageModulePreviewFooter($this);
    }
 
    public function ‪getContentTypeLabel(): string
    {
        if (($typeColumn = $this->‪getTypeColumn()) === '') {
            return '';
        }
        $contentType = $this->record[$typeColumn] ?? '';
        $contentTypeLabels = $this->context->getContentTypeLabels();
        return $contentTypeLabels[$contentType] ??
            BackendUtility::getLabelFromItemListMerged((int)($this->record['pid'] ?? 0), $this->table, $typeColumn, $contentType, $this->record);
    }
 
    public function ‪getIcons(): string
    {
        $row = ‪$this->record;
        $icons = [];
 
        $icon = $this->iconFactory
            ->getIconForRecord($this->table, $row, IconSize::SMALL)
            ->setTitle(BackendUtility::getRecordIconAltText($row, $this->table, false))
            ->render();
        if ($this->‪getBackendUser()->recordEditAccessInternals($this->table, $row)) {
            $icon = BackendUtility::wrapClickMenuOnIcon($icon, $this->table, $row['uid']);
        }
        $icons[] = $icon;
 
        if ($lockInfo = BackendUtility::isRecordLocked($this->table, $row['uid'])) {
            $icons[] = '<a href="#" title="' . htmlspecialchars($lockInfo['msg']) . '">'
                . $this->iconFactory->getIcon('status-user-backend', IconSize::SMALL, 'overlay-edit')->render() . '</a>';
        }
        return implode(' ', $icons);
    }
 
    public function ‪getSiteLanguage(): ‪SiteLanguage
    {
        return $this->context->getSiteLanguage((int)($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['languageField'] ?? null] ?? 0));
    }
 
    public function ‪getRecord(): array
    {
        return ‪$this->record;
    }
 
    public function ‪setRecord(array ‪$record): void
    {
        $this->record = ‪$record;
    }
 
    public function ‪getColumn(): ‪GridColumn
    {
        return $this->column;
    }
 
    public function ‪getTranslations(): array
    {
        return ‪$this->translations;
    }
 
    public function ‪addTranslation(int $languageId, ‪GridColumnItem $translation): ‪GridColumnItem
    {
        $this->translations[$languageId] = $translation;
        return $this;
    }
 
    public function ‪isDisabled(): bool
    {
        $row = $this->‪getRecord();
        $enableCols = ‪$GLOBALS['TCA'][$this->table]['ctrl']['enablecolumns'] ?? null;
        return is_array($enableCols)
            && (
                (($enableCols['disabled'] ?? false) && $row[$enableCols['disabled']])
                || (($enableCols['starttime'] ?? false) && ($row[$enableCols['starttime']] ?? 0) > ‪$GLOBALS['EXEC_TIME'])
                || (($enableCols['endtime'] ?? false) && ($row[$enableCols['endtime']] ?? false) && $row[$enableCols['endtime']] < ‪$GLOBALS['EXEC_TIME'])
            );
    }
 
    public function ‪isEditable(): bool
    {
        $backendUser = $this->‪getBackendUser();
        if ($backendUser->isAdmin()) {
            return true;
        }
        $pageRecord = $this->context->getPageRecord();
        return !($pageRecord['editlock'] ?? false)
            && $backendUser->doesUserHaveAccess($pageRecord, ‪Permission::CONTENT_EDIT)
            && $backendUser->recordEditAccessInternals($this->table, $this->record);
    }
 
    public function ‪isDragAndDropAllowed(): bool
    {
        $pageRecord = $this->context->getPageRecord();
        $typeColumn = $this->‪getTypeColumn();
        return (int)($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['transOrigPointerField'] ?? null] ?? 0) === 0
            && (
                $this->‪getBackendUser()->isAdmin()
                || (
                    ((int)($this->record['editlock'] ?? 0) === 0 && (int)($pageRecord['editlock'] ?? 0) === 0)
                    && $this->‪getBackendUser()->doesUserHaveAccess($pageRecord, ‪Permission::CONTENT_EDIT)
                    && $this->‪getBackendUser()->checkAuthMode($this->table, $typeColumn, $this->record[$typeColumn])
                )
            )
        ;
    }
 
    public function ‪isInconsistentLanguage(): bool
    {
        $allowInconsistentLanguageHandling = $this->context->getDrawingConfiguration()->getAllowInconsistentLanguageHandling();
        return !$allowInconsistentLanguageHandling
            && $this->‪getSiteLanguage()->getLanguageId() !== 0
            && $this->context->getLanguageModeIdentifier() === 'mixed'
            && (int)($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['transOrigPointerField'] ?? null] ?? 0) === 0;
    }
 
    public function ‪getNewContentAfterUrl(): string
    {
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        return (string)$uriBuilder->buildUriFromRoute('new_content_element_wizard', [
            'id' => $this->context->getPageId(),
            'sys_language_uid' => $this->context->getSiteLanguage()->getLanguageId(),
            'colPos' => $this->column->getColumnNumber(),
            'uid_pid' => -$this->record['uid'],
            'returnUrl' => $this->context->getCurrentRequest()->getAttribute('normalizedParams')->getRequestUri(),
        ]);
    }
 
    public function ‪getVisibilityToggleUrl(): string
    {
        $hiddenField = ‪$GLOBALS['TCA'][$this->table]['ctrl']['enablecolumns']['disabled'] ?? null;
        if ($this->record[$hiddenField] ?? false) {
            $value = 0;
        } else {
            $value = 1;
        }
        return GeneralUtility::makeInstance(UriBuilder::class)->buildUriFromRoute(
            'tce_db',
            [
                'data' => [
                    $this->table => [
                        (($this->record['_ORIG_uid'] ?? false) ?: ($this->record['uid'] ?? 0)) => [
                            $hiddenField => $value,
                        ],
                    ],
                ],
                'redirect' => $this->context->getCurrentRequest()->getAttribute('normalizedParams')->getRequestUri(),
            ]
        ) . '#element-' . $this->table . '-' . $this->record['uid'];
    }
 
    public function ‪getVisibilityToggleTitle(): string
    {
        if ($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['enablecolumns']['disabled'] ?? null] ?? false) {
            return $this->‪getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:unHide');
        }
        return $this->‪getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:hide');
    }
 
    public function ‪getVisibilityToggleIconName(): string
    {
        return ($this->record[‪$GLOBALS['TCA'][$this->table]['ctrl']['enablecolumns']['disabled'] ?? null] ?? false) ? 'unhide' : 'hide';
    }
 
    public function ‪isVisibilityToggling(): bool
    {
        $hiddenField = ‪$GLOBALS['TCA'][$this->table]['ctrl']['enablecolumns']['disabled'] ?? null;
        return $hiddenField
            && (‪$GLOBALS['TCA'][$this->table]['columns'][$hiddenField] ?? false)
            && (
                !(‪$GLOBALS['TCA'][$this->table]['columns'][$hiddenField]['exclude'] ?? false)
                || $this->‪getBackendUser()->check('non_exclude_fields', $this->table . ':' . $hiddenField)
            )
        ;
    }
 
    public function ‪getEditUrl(): string
    {
        $urlParameters = [
            'edit' => [
                $this->table => [
                    $this->record['uid'] => 'edit',
                ],
            ],
            'returnUrl' => $this->context->getCurrentRequest()->getAttribute('normalizedParams')->getRequestUri() . '#element-' . $this->table . '-' . $this->record['uid'],
        ];
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        return $uriBuilder->buildUriFromRoute('record_edit', $urlParameters) . '#element-' . $this->table . '-' . $this->record['uid'];
    }
 
    protected function ‪getReferenceCount(int ‪$uid): int
    {
        return GeneralUtility::makeInstance(ReferenceIndex::class)->getNumberOfReferencedRecords($this->table, ‪$uid);
    }
 
    protected function ‪getTypeColumn(): string
    {
        return (string)(‪$GLOBALS['TCA'][$this->table]['ctrl']['type'] ?? '');
    }
}