Yiisoft\Yii\AuthClient\Collection

Complexity

Total Complexity

8

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Test Coverage

Coverage

85.71%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getClient()	0	13	3
A	hasClient()	0	3	1
A	getClients()	0	8	2
A	setClients()	0	3	1
A	__construct()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\AuthClient;

use InvalidArgumentException;
use RuntimeException;

/**
 * Collection is a storage for all auth clients in the application.
 *
 * Example application configuration:
 *
 * ```php
 * 'authClients' => [
 *     'google' => [
 *         '__class' => Yiisoft\Yii\AuthClient\Clients\Google::class,
 *         'setClientId()' => ['google_client_id'],
 *         'setClientSecret()' => ['google_client_secret'],
 *      ],
 *     'facebook' => [
 *         '__class' => Yiisoft\Yii\AuthClient\Clients\Facebook::class,
 *         'setClientId()' => ['facebook_client_id'],
 *         'setClientSecret()' => ['facebook_client_secret'],
 *     ]
 *     ...
 * ]
 * ```
 */
final class Collection
{
    /**
     * @var AuthClientInterface[]|array list of Auth clients with their configuration in format: 'clientName' => [...]
     */
    private array $clients;

    public function __construct(array $clients)
    {
        $this->clients = $clients;
    }

    /**
     * @return AuthClientInterface[] list of auth clients.
     */
    public function getClients(): array
    {
        $clients = [];
        foreach ($this->clients as $name => $client) {
            $clients[$name] = $this->getClient($name);
        }

        return $clients;
    }

    /**
     * @param array $clients list of auth clients indexed by their names
     */
    public function setClients(array $clients): void
    {
        $this->clients = $clients;
    }

    /**
     * @param string $name client name
     *
     * @throws InvalidArgumentException on non existing client request.
     * @return AuthClientInterface auth client instance.
     */
    public function getClient(string $name): AuthClientInterface
    {
        if (!$this->hasClient($name)) {
            throw new InvalidArgumentException("Unknown auth client '{$name}'.");
        }

        $client = $this->clients[$name];
        if (!($client instanceof AuthClientInterface)) {
            throw new RuntimeException(
                'Client should be ClientInterface instance. "' . get_class($client) . '" given.'
            );
        }
        return $client;
    }

    /**
     * Checks if client exists in the hub.
     *
     * @param string $name client id.
     *
     * @return bool whether client exist.
     */
    public function hasClient(string $name): bool
    {
        return array_key_exists($name, $this->clients);
    }
}