pheature-flags / toggle-crud-psr11-factories

src/ToggleConfig.php

<?php

declare(strict_types=1);

namespace Pheature\Crud\Psr11\Toggle;

use Webmozart\Assert\Assert;

/**
 * @psalm-import-type WriteFeature from \Pheature\Core\Toggle\Write\Feature
 * @psalm-import-type InMemoryFeature from \Pheature\InMemory\Toggle\InMemoryConfig
 * @psalm-type StrategyTypeFactoryConfig array<array{type: string, factory_id: string}>
 * @psalm-type SegmentTypeFactoryConfig array<array{type: string, factory_id: string}>
 * @psalm-type ToggleConfigOptions array{
 *   api_enabled: bool,
 *   api_prefix: string,
 *   driver: string,
 *   driver_options?: array<string>,
 *   strategy_types?: StrategyTypeFactoryConfig,
 *   segment_types?: SegmentTypeFactoryConfig,
 *   toggles?: array<InMemoryFeature>
 * }
 */
final class ToggleConfig
{
    public const DRIVER_IN_MEMORY = 'inmemory';
    public const DRIVER_DBAL = 'dbal';
    public const DRIVER_CHAIN = 'chain';
    private const VALID_DRIVERS = [
        self::DRIVER_IN_MEMORY,
        self::DRIVER_DBAL,
        self::DRIVER_CHAIN,
    ];
    private const VALID_DRIVER_OPTIONS = [
        self::DRIVER_IN_MEMORY,
        self::DRIVER_DBAL,
    ];

    private string $driver;
    /** @var array<string> */
    private $driverOptions;
    private bool $apiEnabled;
    private string $apiPrefix;
    /** @var StrategyTypeFactoryConfig */

The type Pheature\Crud\Psr11\Toggle\StrategyTypeFactoryConfig was not found. Maybe you did not declare it correctly or list all dependencies?

    private array $strategyTypes;
    /** @var SegmentTypeFactoryConfig */

The type Pheature\Crud\Psr11\Toggle\SegmentTypeFactoryConfig was not found. Maybe you did not declare it correctly or list all dependencies?

    private array $segmentTypes;
    /** @var array<InMemoryFeature> */
    private array $toggles;

    /**
     * @param array<string, mixed> $config
     */
    public function __construct(array $config)
    {
        $this->assertDriver($config);
        Assert::keyExists($config, 'api_enabled');
        Assert::boolean($config['api_enabled']);
        Assert::keyExists($config, 'api_prefix');
        Assert::string($config['api_prefix']);

        $this->apiEnabled = $config['api_enabled'];
        $this->apiPrefix = $config['api_prefix'];
        /** @var string $driver */
        $driver = $config['driver'];
        $this->driver = $driver;
        /** @var array<string> $driverOptions */
        $driverOptions = $config['driver_options'] ?? [];
        $this->driverOptions = $driverOptions;

        $this->strategyTypes = [];

It seems like array() of type array is incompatible with the declared type Pheature\Crud\Psr11\Toggle\StrategyTypeFactoryConfig of property $strategyTypes.

        $this->segmentTypes = [];

It seems like array() of type array is incompatible with the declared type Pheature\Crud\Psr11\Toggle\SegmentTypeFactoryConfig of property $segmentTypes.

        $this->toggles = [];

        if (array_key_exists('strategy_types', $config)) {
            Assert::isArray($config['strategy_types']);
            /** @var array<array{type: string, factory_id: string}> $strategyTypes */
            $strategyTypes = $config['strategy_types'];
            $this->strategyTypes = $strategyTypes;
        }

        if (array_key_exists('segment_types', $config)) {
            Assert::isArray($config['segment_types']);
            /** @var array<array{type: string, factory_id: string}> $segmentTypes */
            $segmentTypes = $config['segment_types'];
            $this->segmentTypes = $segmentTypes;
        }

        if (array_key_exists('toggles', $config)) {
            Assert::isArray($config['toggles']);
            /** @var array<InMemoryFeature> $toggles */
            $toggles = $config['toggles'];
            $this->toggles = $toggles;
        }
    }

    /**
     * @param array<string, mixed> $config
     * @return void
     */
    private function assertDriver(array $config): void
    {
        Assert::keyExists($config, 'driver');
        Assert::inArray($config['driver'], self::VALID_DRIVERS);

        $this->assertDriverOptions($config);
    }

    /**
     * @param array<string, mixed> $config
     * @return void
     */
    private function assertDriverOptions(array $config): void
    {
        if (self::DRIVER_CHAIN === $config['driver']) {
            Assert::keyExists($config, 'driver_options');
            Assert::notEmpty($config['driver_options']);
            Assert::allInArray($config['driver_options'], self::VALID_DRIVER_OPTIONS);
        }
    }

    public function apiEnabled(): bool
    {
        return $this->apiEnabled;
    }

    public function apiPrefix(): string
    {
        return $this->apiPrefix;
    }

    public function driver(): string
    {
        return $this->driver;
    }

    /**
     * @return array<string>
     */
    public function driverOptions(): array
    {
        return $this->driverOptions;
    }

    /** @return StrategyTypeFactoryConfig */
    public function strategyTypes(): array
    {
        return $this->strategyTypes;

The expression return $this->strategyTypes returns the type array which is incompatible with the documented return type Pheature\Crud\Psr11\Toggle\StrategyTypeFactoryConfig.

    }

    /** @return SegmentTypeFactoryConfig */
    public function segmentTypes(): array
    {
        return $this->segmentTypes;

The expression return $this->segmentTypes returns the type array which is incompatible with the documented return type Pheature\Crud\Psr11\Toggle\SegmentTypeFactoryConfig.

    }

    /** @return array<InMemoryFeature> */
    public function toggles(): array
    {
        return $this->toggles;
    }
}