Your IP : 216.73.217.13
<?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\Routing\UriBuilder;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\View\Event\AfterSectionMarkupGeneratedEvent;
use TYPO3\CMS\Backend\View\Event\BeforeSectionMarkupGeneratedEvent;
use TYPO3\CMS\Backend\View\PageLayoutContext;
use TYPO3\CMS\Core\Type\Bitmask\Permission;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* Grid Column
*
* Object representation (model/proxy) for a single column from a grid defined
* in a BackendLayout. Stores GridColumnItem representations of content records
* and provides getter methods which return various properties associated with
* a single column, e.g. the "edit all elements in content" URL and the "add
* new content element" URL of the button that is placed in the top of columns
* in the page layout.
*
* Accessed from Fluid templates.
*
* @internal this is experimental and subject to change in TYPO3 v10 / v11
*/
class GridColumn extends AbstractGridObject
{
/**
* @var GridColumnItem[]
*/
protected $items = [];
/**
* @var int|null
*/
protected $columnNumber;
/**
* @var string
*/
protected $columnName = 'default';
/**
* @var string|null
*/
protected $icon;
/**
* @var int
*/
protected $colSpan = 1;
/**
* @var int
*/
protected $rowSpan = 1;
/**
* @var array<string, mixed>
*/
protected $definition;
private EventDispatcherInterface $eventDispatcher;
public function __construct(PageLayoutContext $context, array $definition)
{
parent::__construct($context);
$this->definition = $definition;
$this->columnNumber = isset($definition['colPos']) ? (int)$definition['colPos'] : null;
$this->columnName = $definition['name'] ?? $this->columnName;
$this->icon = $definition['icon'] ?? $this->icon;
$this->colSpan = (int)($definition['colspan'] ?? $this->colSpan);
$this->rowSpan = (int)($definition['rowspan'] ?? $this->rowSpan);
$this->eventDispatcher = GeneralUtility::makeInstance(EventDispatcherInterface::class);
}
/**
* @return array<string, mixed>
*/
public function getDefinition(): array
{
return $this->definition;
}
public function isActive(): bool
{
return $this->columnNumber !== null && in_array($this->columnNumber, $this->context->getDrawingConfiguration()->getActiveColumns());
}
public function addItem(GridColumnItem $item): void
{
$this->items[] = $item;
}
/**
* @return GridColumnItem[]
*/
public function getItems(): iterable
{
return $this->items;
}
public function getColumnNumber(): ?int
{
return $this->columnNumber;
}
public function getColumnName(): string
{
return $this->columnName;
}
public function getIcon(): ?string
{
return $this->icon;
}
public function getColSpan(): int
{
if ($this->context->getDrawingConfiguration()->getLanguageMode()) {
return 1;
}
return $this->colSpan;
}
public function getRowSpan(): int
{
if ($this->context->getDrawingConfiguration()->getLanguageMode()) {
return 1;
}
return $this->rowSpan;
}
/**
* @return int[]
*/
public function getAllContainedItemUids(): array
{
$uids = [];
foreach ($this->items as $columnItem) {
$uids[] = (int)$columnItem->getRecord()['uid'];
}
return $uids;
}
public function getEditUrl(): ?string
{
if (empty($this->items)) {
return null;
}
$pageRecord = $this->context->getPageRecord();
if (!$this->getBackendUser()->doesUserHaveAccess($pageRecord, Permission::CONTENT_EDIT)
|| !$this->getBackendUser()->checkLanguageAccess($this->context->getSiteLanguage()->getLanguageId())) {
return null;
}
$pageTitleParamForAltDoc = '&recTitle=' . rawurlencode(
BackendUtility::getRecordTitle('pages', $pageRecord, true)
);
$editParam = '&edit[tt_content][' . implode(',', $this->getAllContainedItemUids()) . ']=edit' . $pageTitleParamForAltDoc;
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
return $uriBuilder->buildUriFromRoute('record_edit') . $editParam . '&returnUrl=' . rawurlencode($GLOBALS['TYPO3_REQUEST']->getAttribute('normalizedParams')->getRequestUri());
}
public function getNewContentUrl(): string
{
$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
$pageId = $this->context->getPageId();
return (string)$uriBuilder->buildUriFromRoute('new_content_element_wizard', [
'id' => $pageId,
'sys_language_uid' => $this->context->getSiteLanguage()->getLanguageId(),
'colPos' => $this->getColumnNumber(),
'uid_pid' => $pageId,
'returnUrl' => $GLOBALS['TYPO3_REQUEST']->getAttribute('normalizedParams')->getRequestUri(),
]);
}
public function getTitle(): string
{
$columnNumber = $this->getColumnNumber();
$colTitle = BackendUtility::getProcessedValue('tt_content', 'colPos', (string)$columnNumber) ?? '';
foreach ($this->context->getBackendLayout()->getUsedColumns() as $colPos => $title) {
if ($colPos === $columnNumber) {
$colTitle = (string)$this->getLanguageService()->sL($title);
}
}
return $colTitle;
}
public function getTitleInaccessible(): string
{
return $this->getLanguageService()->sL($this->columnName) . ' (' . $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:noAccess') . ')';
}
public function getTitleUnassigned(): string
{
return $this->getLanguageService()->sL($this->columnName) . ' (' . $this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang_layout.xlf:notAssigned') . ')';
}
public function getBeforeSectionMarkup(): string
{
$event = new BeforeSectionMarkupGeneratedEvent($this->definition, $this->context, $this->getRecords());
$this->eventDispatcher->dispatch($event);
return $event->getContent();
}
public function getAfterSectionMarkup(): string
{
$event = new AfterSectionMarkupGeneratedEvent($this->definition, $this->context, $this->getRecords());
$this->eventDispatcher->dispatch($event);
return $event->getContent();
}
public function isUnassigned(): bool
{
return $this->columnName !== 'unused' && $this->columnNumber === null;
}
public function isUnused(): bool
{
return $this->columnName === 'unused' && $this->columnNumber === null;
}
public function isContentEditable(): bool
{
if ($this->columnName === 'unused' || $this->columnNumber === null) {
return false;
}
if ($this->getBackendUser()->isAdmin()) {
return true;
}
$pageRecord = $this->context->getPageRecord();
return !$pageRecord['editlock']
&& $this->getBackendUser()->doesUserHaveAccess($pageRecord, Permission::CONTENT_EDIT)
&& $this->getBackendUser()->checkLanguageAccess($this->context->getSiteLanguage()->getLanguageId());
}
/**
* Get the raw records for the current column
*
* @return array<int, array<string, mixed>>
*/
protected function getRecords(): array
{
if ($this->items === []) {
return [];
}
$records = [];
foreach ($this->items as $item) {
$record = $item->getRecord();
$records[(int)$record['uid']] = $record;
}
return $records;
}
}