ResultItem.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\Search\LiveSearch;
 
use ‪TYPO3\CMS\Core\Imaging\Icon;
 
final class ‪ResultItem implements \JsonSerializable
{
    private string ‪$itemTitle = '';
    private string ‪$typeLabel = '';
    private ?‪Icon ‪$icon = null;
    private array ‪$actions = [];
    private array ‪$extraData = [];
    private array ‪$internalData = [];
 
    public function ‪__construct(private readonly string $providerClassName) {}
 
    public function ‪getProviderClassName(): string
    {
        return $this->providerClassName;
    }
 
    public function ‪setItemTitle(string ‪$itemTitle): self
    {
        $this->itemTitle = ‪$itemTitle;
 
        return $this;
    }
 
    public function ‪setTypeLabel(string ‪$typeLabel): self
    {
        $this->typeLabel = ‪$typeLabel;
 
        return $this;
    }
 
    public function ‪setIcon(‪Icon ‪$icon): self
    {
        $this->icon = ‪$icon;
 
        return $this;
    }
 
    public function ‪setActions(‪ResultItemAction ...$action): self
    {
        $this->actions = $action;
 
        return $this;
    }
 
    public function ‪addAction(‪ResultItemAction $action): self
    {
        $this->actions[] = $action;
 
        return $this;
    }
 
    public function ‪getExtraData(): array
    {
        return ‪$this->extraData;
    }
 
    public function ‪setExtraData(array ‪$extraData): ‪ResultItem
    {
        $this->extraData = ‪$extraData;
        return $this;
    }
 
    public function ‪getInternalData(): array
    {
        return ‪$this->internalData;
    }
 
    public function ‪setInternalData(array ‪$internalData): ‪ResultItem
    {
        $this->internalData = ‪$internalData;
 
        return $this;
    }
 
    public function ‪jsonSerialize(): array
    {
        return [
            'provider' => $this->providerClassName,
            'itemTitle' => ‪$this->itemTitle,
            'typeLabel' => ‪$this->typeLabel,
            'icon' => [
                'identifier' => $this->icon?->getIdentifier(),
                'overlay' => $this->icon?->getOverlayIcon()?->getIdentifier(),
            ],
            'actions' => ‪$this->actions,
            'extraData' => ‪$this->extraData,
        ];
    }
}