JavaScriptModuleInstruction.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;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪JavaScriptModuleInstruction implements \JsonSerializable
{
    public const ‪FLAG_LOAD_REQUIRE_JS = 1;
 
    public const ‪FLAG_USE_TOP_WINDOW = 16;
 
    public const ‪ITEM_ASSIGN = 'assign';
    public const ‪ITEM_INVOKE = 'invoke';
    public const ‪ITEM_INSTANCE = 'instance';
 
    protected string ‪$name;
    protected ?string ‪$exportName;
    protected int ‪$flags;
    protected array ‪$items = [];
 
    public static function ‪forRequireJS(string ‪$name, string ‪$exportName = null): self
    {
        $target = GeneralUtility::makeInstance(static::class, ‪$name, self::FLAG_LOAD_REQUIRE_JS);
        $target->exportName = ‪$exportName;
        return $target;
    }
 
    public function ‪__construct(string ‪$name, int ‪$flags)
    {
        $this->name = ‪$name;
        $this->flags = ‪$flags;
    }
 
    public function ‪jsonSerialize(): array
    {
        return [
            'name' => ‪$this->name,
            'exportName' => ‪$this->exportName,
            'flags' => ‪$this->flags,
            'items' => ‪$this->items,
        ];
    }
 
    public function ‪getName(): string
    {
        return ‪$this->name;
    }
 
    public function ‪getExportName(): ?string
    {
        return ‪$this->exportName;
    }
 
    public function ‪getFlags(): int
    {
        return ‪$this->flags;
    }
 
    public function ‪getItems(): array
    {
        return ‪$this->items;
    }
 
    public function ‪addFlags(int ...‪$flags): self
    {
        foreach (‪$flags as $flag) {
            $this->flags |= $flag;
        }
        return $this;
    }
 
    public function ‪assign(array $assignments): self
    {
        $this->items[] = [
            'type' => static::ITEM_ASSIGN,
            'assignments' => $assignments,
        ];
        return $this;
    }
 
    public function ‪invoke(string $method, ...‪$args): self
    {
        $this->items[] = [
            'type' => static::ITEM_INVOKE,
            'method' => $method,
            'args' => ‪$args,
        ];
        return $this;
    }
 
    public function ‪instance(...‪$args): self
    {
        $this->items[] = [
            'type' => static::ITEM_INSTANCE,
            'args' => ‪$args,
        ];
        return $this;
    }
 
    public function ‪shallLoadRequireJs(): bool
    {
        return ($this->flags & self::FLAG_LOAD_REQUIRE_JS) === ‪self::FLAG_LOAD_REQUIRE_JS;
    }
 
    public function ‪shallUseTopWindow(): bool
    {
        return ($this->flags & self::FLAG_USE_TOP_WINDOW) === ‪self::FLAG_USE_TOP_WINDOW;
    }
}