ModifyRecordListHeaderColumnsEvent.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\RecordList\Event;
 
use ‪TYPO3\CMS\Backend\RecordList\DatabaseRecordList;
 
final class ‪ModifyRecordListHeaderColumnsEvent
{
    private array ‪$headerAttributes = [];
 
    public function ‪__construct(
        private array $columns,
        private readonly string $table,
        private readonly array $recordIds,
        private readonly ‪DatabaseRecordList $recordList
    ) {}
 
    public function ‪setColumn(string $column, string $columnName = ''): void
    {
        if ($columnName !== '') {
            $this->columns[$columnName] = $column;
        } else {
            $this->columns[] = $column;
        }
    }
 
    public function ‪hasColumn(string $columnName): bool
    {
        return (bool)($this->columns[$columnName] ?? false);
    }
 
    public function ‪getColumn(string $columnName): ?string
    {
        return $this->columns[$columnName] ?? null;
    }
 
    public function ‪removeColumn(string $columnName): bool
    {
        if (!isset($this->columns[$columnName])) {
            return false;
        }
        unset($this->columns[$columnName]);
        return true;
    }
 
    public function ‪setColumns(array $columns): void
    {
        $this->columns = $columns;
    }
 
    public function ‪getColumns(): array
    {
        return $this->columns;
    }
 
    public function ‪setHeaderAttributes(array ‪$headerAttributes): void
    {
        $this->headerAttributes = ‪$headerAttributes;
    }
 
    public function ‪getHeaderAttributes(): array
    {
        return ‪$this->headerAttributes;
    }
 
    public function ‪getTable(): string
    {
        return $this->table;
    }
 
    public function ‪getRecordIds(): array
    {
        return $this->recordIds;
    }
 
    public function ‪getRecordList(): ‪DatabaseRecordList
    {
        return $this->recordList;
    }
}