mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2025-07-10 02:14:31 +02:00
Added an very basic system to configure info providers
This commit is contained in:
parent
9e3cb4d694
commit
e0301f096f
12 changed files with 689 additions and 0 deletions
107
src/Services/InfoProviderSystem/ProviderRegistry.php
Normal file
107
src/Services/InfoProviderSystem/ProviderRegistry.php
Normal file
|
@ -0,0 +1,107 @@
|
|||
<?php
|
||||
/*
|
||||
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
|
||||
*
|
||||
* Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published
|
||||
* by the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
|
||||
namespace App\Services\InfoProviderSystem;
|
||||
|
||||
use App\Services\InfoProviderSystem\Providers\InfoProviderInterface;
|
||||
|
||||
class ProviderRegistry
|
||||
{
|
||||
|
||||
/**
|
||||
* @var InfoProviderInterface[] The info providers index by their keys
|
||||
* @psalm-var array
|
||||
*/
|
||||
private array $providers_by_name = [];
|
||||
|
||||
/**
|
||||
* @var InfoProviderInterface[] The enabled providers indexed by their keys
|
||||
* @psalm-var array
|
||||
*/
|
||||
private array $providers_active = [];
|
||||
|
||||
/**
|
||||
* @var InfoProviderInterface[] The disabled providers indexed by their keys
|
||||
* @psalm-var array
|
||||
*/
|
||||
private array $providers_disabled = [];
|
||||
|
||||
/**
|
||||
* @param iterable<InfoProviderInterface> $providers
|
||||
*/
|
||||
public function __construct(private readonly iterable $providers)
|
||||
{
|
||||
foreach ($providers as $provider) {
|
||||
$key = $provider->getProviderKey();
|
||||
|
||||
if (isset($this->providers_by_name[$key])) {
|
||||
throw new \LogicException("Provider with key $key already registered");
|
||||
}
|
||||
|
||||
$this->providers_by_name[$key] = $provider;
|
||||
if ($provider->isActive()) {
|
||||
$this->providers_active[$key] = $provider;
|
||||
} else {
|
||||
$this->providers_disabled[$key] = $provider;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of all registered providers (enabled and disabled)
|
||||
* @return InfoProviderInterface[]
|
||||
*/
|
||||
public function getProviders(): array
|
||||
{
|
||||
return $this->providers_by_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the provider identified by the given key
|
||||
* @param string $key
|
||||
* @return InfoProviderInterface
|
||||
* @throws \InvalidArgumentException If the provider with the given key does not exist
|
||||
*/
|
||||
public function getProviderByKey(string $key): InfoProviderInterface
|
||||
{
|
||||
return $this->providers_by_name[$key] ?? throw new \InvalidArgumentException("Provider with key $key not found");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of all active providers
|
||||
* @return InfoProviderInterface[]
|
||||
*/
|
||||
public function getActiveProviders(): array
|
||||
{
|
||||
return $this->providers_active;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of all disabled providers
|
||||
* @return InfoProviderInterface[]
|
||||
*/
|
||||
public function getDisabledProviders(): array
|
||||
{
|
||||
return $this->providers_disabled;
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue