JavaScriptItems.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\Core\Page;
 
class JavaScriptItems implements \JsonSerializable
{
    protected array $globalAssignments = [];
 
    protected array $javaScriptModuleInstructions = [];
 
    public function jsonSerialize(): array
    {
        return $this->toArray();
    }
 
    public function addGlobalAssignment(array $payload): void
    {
        if (empty($payload)) {
            return;
        }
        $this->globalAssignments[] = $payload;
    }
 
    public function addJavaScriptModuleInstruction(JavaScriptModuleInstruction $instruction): void
    {
        $this->javaScriptModuleInstructions[] = $instruction;
    }
 
    public function toArray(): array
    {
        if ($this->isEmpty()) {
            return [];
        }
        $items = [];
        foreach ($this->globalAssignments as $item) {
            $items[] = [
                'type' => 'globalAssignment',
                'payload' => $item,
            ];
        }
        foreach ($this->javaScriptModuleInstructions as $item) {
            $items[] = [
                'type' => 'javaScriptModuleInstruction',
                'payload' => $item,
            ];
        }
        return $items;
    }
 
    public function isEmpty(): bool
    {
        return $this->globalAssignments === []
            && empty($this->javaScriptModuleInstructions);
    }
 
    public function updateState(array $state): void
    {
        $this->globalAssignments = $state['globalAssignments'] ?? [];
        $this->javaScriptModuleInstructions = [];
        foreach ($state['javaScriptModuleInstructions'] ?? [] as $instruction) {
            $this->javaScriptModuleInstructions[] = ‪JavaScriptModuleInstruction::fromState($instruction);
        }
    }
 
    public function getState(): array
    {
        return [
            'globalAssignments' => $this->globalAssignments,
            'javaScriptModuleInstructions' => array_map(
                static fn(JavaScriptModuleInstruction $instruction): array => $instruction->getState(),
                $this->javaScriptModuleInstructions
            ),
        ];
    }
}