TYPO3\CMS\Extensionmanager\Remote\RemoteRegistry

Complexity

Total Complexity

21

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	registerRemote()	0	27	5
A	getDefaultRemote()	0	6	2
A	getRemote()	0	8	3
A	hasRemote()	0	3	2
A	hasDefaultRemote()	0	3	1
A	__construct()	0	3	1
A	getListableRemotes()	0	5	4
A	getAllRemotes()	0	5	3

<?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\Remote;

use Psr\Container\ContainerInterface;
use TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;

/**
 * Registry of remote connectors.
 *
 * @internal This class is a specific implementation and is not part of the Public TYPO3 API.
 */
class RemoteRegistry
{
    /**
     * @var ContainerInterface
     */
    protected $container;

    /**
     * @var ExtensionDownloaderRemoteInterface[]
     */
    protected $remotes = [];

    /**
     * @var ExtensionDownloaderRemoteInterface
     */
    protected $defaultRemote;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    public function registerRemote(string $id, array $configuration): void
    {
        $remote = $this->container->get($id);

        if (!$remote instanceof ExtensionDownloaderRemoteInterface) {
            throw new ExtensionManagerException(
                'Extension remote ' . $id . ' must implement ' . ExtensionDownloaderRemoteInterface::class,
                1602173538
            );
        }

        $identifier = $remote->getIdentifier();

        $this->remotes[$identifier] = array_merge(
            $configuration,
            [
                'service' => $remote,
                'listable' => $remote instanceof ListableRemoteInterface
            ]
        );

        if ($this->remotes[$identifier]['default']
            && $this->remotes[$identifier]['enabled']
            && $this->remotes[$identifier]['listable']
        ) {
            // This overrides a previously set default remote
            $this->defaultRemote = $remote;
        }
    }

    public function hasRemote(string $identifier): bool
    {
        return isset($this->remotes[$identifier]) && $this->remotes[$identifier]['enabled'];
    }

    public function getRemote(string $identifier): ExtensionDownloaderRemoteInterface
    {
        if (isset($this->remotes[$identifier]) && $this->remotes[$identifier]['enabled']) {
            return $this->remotes[$identifier]['service'];
        }
        throw new RemoteNotRegisteredException(
            'The requested remote ' . $identifier . ' is not registered in this system or not enabled',
            1601566451
        );
    }

    public function hasDefaultRemote(): bool
    {
        return isset($this->defaultRemote);
    }

    public function getDefaultRemote(): ExtensionDownloaderRemoteInterface
    {
        if ($this->defaultRemote !== null) {
            return $this->defaultRemote;
        }
        throw new RemoteNotRegisteredException('No default remote registered in this system', 1602226715);
    }

    /**
     * @return ListableRemoteInterface[]
     */
    public function getListableRemotes(): iterable
    {
        foreach ($this->remotes as $remote) {
            if ($remote['listable'] && $remote['enabled']) {
                yield $remote['service'];

The expression yield $remote['service'] returns the type Generator which is incompatible with the documented return type TYPO3\CMS\Extensionmanager\Remote\ListableRemoteInterface[].

            }
        }
    }

    /**
     * @return ExtensionDownloaderRemoteInterface[]
     */
    public function getAllRemotes(): iterable
    {
        foreach ($this->remotes as $remote) {
            if ($remote['enabled']) {
                yield $remote['service'];

The expression yield $remote['service'] returns the type Generator which is incompatible with the documented return type TYPO3\CMS\Extensionmanager\Remote\ExtensionDownloaderRemoteInterface[].

            }
        }
    }
}