Files
cms-backend/Classes/Controller/Event/AfterPageColumnsSelectedForLocalizationEvent.php
T

87 lines
2.3 KiB
PHP

<?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\Controller\Event;
use TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
/**
* This event triggers after the LocalizationController (AJAX) has
* selected page columns to be translated. Allows third parties to
* add to or change the columns and content elements withing those
* columns which will be available for localization through the
* "translate" modal in the page module.
*/
final class AfterPageColumnsSelectedForLocalizationEvent
{
public function __construct(
private array $columns,
private array $columnList,
private readonly BackendLayout $backendLayout,
private readonly array $records,
private readonly array $parameters
) {}
/**
* Returns list of columns, indexed by column position number, value is label (either LLL: or hardcoded).
*/
public function getColumns(): array
{
return $this->columns;
}
public function setColumns(array $columns): void
{
$this->columns = $columns;
}
/**
* Returns a list of integer column position numbers used in the BackendLayout.
*/
public function getColumnList(): array
{
return $this->columnList;
}
public function setColumnList(array $columnList): void
{
$this->columnList = $columnList;
}
public function getBackendLayout(): BackendLayout
{
return $this->backendLayout;
}
/**
* Returns an array of records which were used when building the original column
* manifest and column position numbers list.
*/
public function getRecords(): array
{
return $this->records;
}
/**
* Returns request parameters passed to LocalizationController.
*/
public function getParameters(): array
{
return $this->parameters;
}
}