ModifyRecordListRecordActionsEvent.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 ‪ModifyRecordListRecordActionsEvent
{
    public function ‪__construct(
        private array $actions,
        private readonly string $table,
        private readonly array ‪$record,
        private readonly ‪DatabaseRecordList $recordList
    ) {}
 
    public function ‪setAction(
        string $action,
        string $actionName = '',
        string $group = '',
        string $before = '',
        string $after = ''
    ): void {
        // Only "primary" and "secondary" are valid, default to "secondary" otherwise
        $group = in_array($group, ['primary', 'secondary'], true) ? $group : 'secondary';
 
        if ($actionName !== '') {
            if ($before !== '' && $this->‪hasAction($before, $group)) {
                $end = array_splice($this->actions[$group], (int)(array_search($before, array_keys($this->actions[$group]), true)));
                $this->actions[$group] = array_merge($this->actions[$group], [$actionName => $action], $end);
            } elseif ($after !== '' && $this->‪hasAction($after, $group)) {
                $end = array_splice($this->actions[$group], (int)(array_search($after, array_keys($this->actions[$group]), true)) + 1);
                $this->actions[$group] = array_merge($this->actions[$group], [$actionName => $action], $end);
            } else {
                $this->actions[$group][$actionName] = $action;
            }
        } else {
            $this->actions[$group][] = $action;
        }
    }
 
    public function ‪hasAction(string $actionName, string $group = ''): bool
    {
        if (in_array($group, ['primary', 'secondary'], true)) {
            return (bool)($this->actions[$group][$actionName] ?? false);
        }
 
        return (bool)($this->actions['primary'][$actionName] ?? $this->actions['secondary'][$actionName] ?? false);
    }
 
    public function ‪getAction(string $actionName, string $group = ''): ?string
    {
        if (in_array($group, ['primary', 'secondary'], true)) {
            return $this->actions[$group][$actionName] ?? null;
        }
 
        return $this->actions['primary'][$actionName] ?? $this->actions['secondary'][$actionName] ?? null;
    }
 
    public function ‪removeAction(string $actionName, string $group = ''): bool
    {
        if (($this->actions[$group][$actionName] ?? false) && in_array($group, ['primary', 'secondary'], true)) {
            unset($this->actions[$group][$actionName]);
            return true;
        }
 
        $actionRemoved = false;
 
        if ($this->actions['primary'][$actionName] ?? false) {
            unset($this->actions['primary'][$actionName]);
            $actionRemoved = true;
        }
 
        if ($this->actions['secondary'][$actionName] ?? false) {
            unset($this->actions['secondary'][$actionName]);
            $actionRemoved = true;
        }
 
        return $actionRemoved;
    }
 
    public function ‪getActionGroup(string $group): ?array
    {
        return in_array($group, ['primary', 'secondary'], true) ? $this->actions[$group] : null;
    }
 
    public function ‪setActions(array $actions): void
    {
        $this->actions = $actions;
    }
 
    public function ‪getActions(): array
    {
        return $this->actions;
    }
 
    public function ‪getTable(): string
    {
        return $this->table;
    }
 
    public function ‪getRecord(): array
    {
        return ‪$this->record;
    }
 
    public function ‪getRecordList(): ‪DatabaseRecordList
    {
        return $this->recordList;
    }
}