DownloadQueue.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\Extensionmanager\Domain\Model;
 
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
 
class ‪DownloadQueue implements ‪SingletonInterface
{
    protected array ‪$extensionStorage = [];
 
    protected array ‪$extensionInstallStorage = [];
 
    public function ‪addExtensionToQueue(‪Extension $extension, string $stack = 'download'): void
    {
        if (!in_array($stack, ['download', 'update'])) {
            throw new ‪ExtensionManagerException('Stack has to be either "download" or "update"', 1342432103);
        }
        if (!isset($this->extensionStorage[$stack])) {
            $this->extensionStorage[$stack] = [];
        }
        if (array_key_exists($extension->‪getExtensionKey(), $this->extensionStorage[$stack])) {
            if ($this->extensionStorage[$stack][$extension->‪getExtensionKey()] !== $extension) {
                throw new ‪ExtensionManagerException(
                    $extension->‪getExtensionKey() . ' was requested to be downloaded in different versions (' . $extension->‪getVersion()
                        . ' and ' . $this->extensionStorage[$stack][$extension->‪getExtensionKey()]->getVersion() . ').',
                    1342432101
                );
            }
        }
        $this->extensionStorage[$stack][$extension->‪getExtensionKey()] = $extension;
    }
 
    public function ‪getExtensionQueue(): array
    {
        return ‪$this->extensionStorage;
    }
 
    public function ‪removeExtensionFromQueue(‪Extension $extension, string $stack = 'download'): void
    {
        if (!in_array($stack, ['download', 'update'])) {
            throw new ‪ExtensionManagerException('Stack has to be either "download" or "update"', 1342432104);
        }
        if (array_key_exists($stack, $this->extensionStorage) && is_array($this->extensionStorage[$stack])) {
            if (array_key_exists($extension->‪getExtensionKey(), $this->extensionStorage[$stack])) {
                unset($this->extensionStorage[$stack][$extension->‪getExtensionKey()]);
            }
        }
    }
 
    public function ‪addExtensionToInstallQueue(‪Extension $extension): void
    {
        $this->extensionInstallStorage[$extension->‪getExtensionKey()] = $extension;
    }
 
    public function ‪getExtensionInstallStorage(): array
    {
        return ‪$this->extensionInstallStorage;
    }
 
    public function ‪isQueueEmpty(string $stack): bool
    {
        return empty($this->extensionStorage[$stack]);
    }
 
    public function ‪resetExtensionQueue(?string $stack = null): array
    {
        $storage = [];
        if ($stack === null) {
            $storage = ‪$this->extensionStorage;
            $this->extensionStorage = [];
        } elseif (isset($this->extensionStorage[$stack])) {
            $storage = $this->extensionStorage[$stack];
            $this->extensionStorage[$stack] = [];
        }
 
        return $storage;
    }
 
    public function ‪resetExtensionInstallStorage(): array
    {
        $storage = ‪$this->extensionInstallStorage;
        $this->extensionInstallStorage = [];
 
        return $storage;
    }
}