Storeman\Container

Complexity

Total Complexity

47

Size/Duplication

Total Lines	351
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

41 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	33	1
A	injectConfiguration()	0	11	2
A	injectStoreman()	0	11	2
A	selectVault()	0	6	1
A	get()	0	4	1
A	has()	0	4	1
A	getStoreman()	0	4	1
A	getConfiguration()	0	4	1
A	getVaults()	0	4	1
A	getSelectedVault()	0	4	1
A	getConflictHandler()	0	4	1
A	addConflictHandler()	0	4	1
A	getConflictHandlerNames()	0	4	1
A	getIndexMerger()	0	4	1
A	addIndexMerger()	0	4	1
A	getIndexMergerNames()	0	4	1
A	getIndexBuilder()	0	4	1
A	addIndexBuilder()	0	4	1
A	getIndexBuilderNames()	0	4	1
A	getLockAdapter()	0	4	1
A	addLockAdapter()	0	4	1
A	getLockAdapterNames()	0	4	1
A	getOperationListBuilder()	0	4	1
A	addOperationListBuilder()	0	4	1
A	getOperationListBuilderNames()	0	4	1
A	getStorageAdapter()	0	4	1
A	addStorageAdapter()	0	4	1
A	getStorageAdapterNames()	0	4	1
A	getVaultLayout()	0	4	1
A	addVaultLayout()	0	4	1
A	getVaultLayoutNames()	0	4	1
A	getConflictHandlerServiceName()	0	4	1
A	getIndexBuilderServiceName()	0	4	1
A	getIndexMergerServiceName()	0	4	1
A	getLockAdapterServiceName()	0	4	1
A	getOperationListBuilderServiceName()	0	4	1
A	getStorageAdapterServiceName()	0	4	1
A	getVaultLayoutServiceName()	0	4	1
A	registerServiceFactory()	0	16	3
A	registerVaultServiceFactory()	0	16	3
A	getServiceNamesWithPrefix()	0	21	1

<?php

namespace Storeman;

use League\Container\Definition\DefinitionInterface;
use Psr\Container\ContainerInterface;
use Storeman\ConflictHandler\ConflictHandlerInterface;
use Storeman\ConflictHandler\PanickingConflictHandler;
use Storeman\ConflictHandler\PreferLocalConflictHandler;
use Storeman\ConflictHandler\PreferRemoteConflictHandler;
use Storeman\IndexBuilder\IndexBuilderInterface;
use Storeman\IndexBuilder\StandardIndexBuilder;
use Storeman\IndexMerger\IndexMergerInterface;
use Storeman\IndexMerger\StandardIndexMerger;
use Storeman\LockAdapter\DummyLockAdapter;
use Storeman\LockAdapter\LockAdapterInterface;
use Storeman\LockAdapter\StorageBasedLockAdapter;
use Storeman\OperationListBuilder\OperationListBuilderInterface;
use Storeman\OperationListBuilder\StandardOperationListBuilder;
use Storeman\StorageAdapter\LocalStorageAdapter;
use Storeman\StorageAdapter\StorageAdapterInterface;
use Storeman\Validation\Constraints\ExistingServiceValidator;
use Storeman\VaultLayout\Amberjack\AmberjackVaultLayout;
use Storeman\VaultLayout\VaultLayoutInterface;

/**
 * Dependency injection container for modularized parts.
 * It is basically a facade for a PSR container implementation with some additional accessors for type safety.
 */
final class Container implements ContainerInterface
{
    protected const PREFIX_CONFLICT_HANDLER = 'conflictHandler.';
    protected const PREFIX_INDEX_BUILDER = 'indexBuilder.';
    protected const PREFIX_INDEX_MERGER = 'indexMerger.';
    protected const PREFIX_LOCK_ADAPTER = 'lockAdapter.';
    protected const PREFIX_OPERATION_LIST_BUILDER = 'operationListBuilder.';
    protected const PREFIX_STORAGE_ADAPTER = 'storageAdapter.';
    protected const PREFIX_VAULT_LAYOUT = 'vaultLayout.';


    /**
     * @var InspectableContainer
     */
    protected $delegate;

    /**
     * Sets up the container with all bundled services.
     *
     * Note: Be very careful with shared services as the container is used shared by all vaults of a storeman instance.
     */
    public function __construct()
    {
        $this->delegate = new InspectableContainer();

        $this->delegate->add('vaults', new VaultContainer(), true);
        $this->delegate->add('vaultConfiguration', function(Vault $vault) { return $vault->getVaultConfiguration(); })->withArgument('vault');

        $this->registerServiceFactory('indexBuilder');
        $this->addIndexBuilder('standard', StandardIndexBuilder::class, true);

        $this->registerVaultServiceFactory('conflictHandler');
        $this->addConflictHandler('panicking', PanickingConflictHandler::class, true);
        $this->addConflictHandler('preferLocal', PreferLocalConflictHandler::class, true);
        $this->addConflictHandler('preferRemote', PreferRemoteConflictHandler::class, true);

        $this->registerVaultServiceFactory('indexMerger');
        $this->addIndexMerger('standard', StandardIndexMerger::class, true);

        $this->registerVaultServiceFactory('lockAdapter');
        $this->addLockAdapter('dummy', DummyLockAdapter::class);
        $this->addLockAdapter('storage', StorageBasedLockAdapter::class)->withArgument('storageAdapter');

        $this->registerVaultServiceFactory('operationListBuilder');
        $this->addOperationListBuilder('standard', StandardOperationListBuilder::class, true);

        $this->registerVaultServiceFactory('storageAdapter', 'adapter');
        $this->addStorageAdapter('local', LocalStorageAdapter::class)->withArgument('vaultConfiguration');

        $this->registerVaultServiceFactory('vaultLayout');
        $this->addVaultLayout('amberjack', AmberjackVaultLayout::class)->withArguments(['storageAdapter', 'vaultConfiguration']);

        $this->delegate->add(ExistingServiceValidator::class)->withArgument($this);
    }

    public function injectConfiguration(Configuration $configuration): Container
    {
        if ($this->has('configuration'))
        {
            throw new \RuntimeException();
        }

        $this->delegate->add('configuration', $configuration, true);

        return $this;
    }

    public function injectStoreman(Storeman $storeman): Container
    {
        if ($this->has('storeman'))
        {
            throw new \RuntimeException();
        }

        $this->delegate->add('storeman', $storeman, true);

        return $this;
    }

    /**
     * Selects the given vault (or no vault) as the current one.
     *
     * @param Vault $vault
     * @return Container
     */
    public function selectVault(Vault $vault = null): Container
    {
        $this->delegate->add('vault', $vault, true);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function get($id)
    {
        return $this->delegate->get($id);
    }

    /**
     * {@inheritdoc}
     */
    public function has($id)
    {
        return $this->delegate->has($id);
    }


    public function getStoreman(): Storeman
    {
        return $this->get('storeman');
    }

    public function getConfiguration(): Configuration
    {
        return $this->get('configuration');
    }

    public function getVaults(): VaultContainer
    {
        return $this->get('vaults');
    }

    public function getSelectedVault(): ?Vault
    {
        return $this->get('vault');
    }


    public function getConflictHandler(string $name): ConflictHandlerInterface
    {
        return $this->delegate->get($this->getConflictHandlerServiceName($name));
    }

    public function addConflictHandler(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getConflictHandlerServiceName($name), $concrete, $shared);
    }

    public function getConflictHandlerNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_CONFLICT_HANDLER);
    }


    public function getIndexMerger(string $name): IndexMergerInterface
    {
        return $this->delegate->get($this->getIndexMergerServiceName($name));
    }

    public function addIndexMerger(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getIndexMergerServiceName($name), $concrete, $shared);
    }

    public function getIndexMergerNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_INDEX_MERGER);
    }


    public function getIndexBuilder(string $name): IndexBuilderInterface
    {
        return $this->delegate->get($this->getIndexBuilderServiceName($name));
    }

    public function addIndexBuilder(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getIndexBuilderServiceName($name), $concrete, $shared);
    }

    public function getIndexBuilderNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_INDEX_BUILDER);
    }


    public function getLockAdapter(string $name): LockAdapterInterface
    {
        return $this->delegate->get($this->getLockAdapterServiceName($name));
    }

    public function addLockAdapter(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getLockAdapterServiceName($name), $concrete, $shared);
    }

    public function getLockAdapterNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_LOCK_ADAPTER);
    }

    
    public function getOperationListBuilder(string $name): OperationListBuilderInterface
    {
        return $this->delegate->get($this->getOperationListBuilderServiceName($name));
    }

    public function addOperationListBuilder(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getOperationListBuilderServiceName($name), $concrete, $shared);
    }

    public function getOperationListBuilderNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_OPERATION_LIST_BUILDER);
    }


    public function getStorageAdapter(string $name): StorageAdapterInterface
    {
        return $this->delegate->get($this->getStorageAdapterServiceName($name));
    }

    public function addStorageAdapter(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getStorageAdapterServiceName($name), $concrete, $shared);
    }

    public function getStorageAdapterNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_STORAGE_ADAPTER);
    }


    public function getVaultLayout(string $name): VaultLayoutInterface
    {
        return $this->delegate->get($this->getVaultLayoutServiceName($name));
    }

    public function addVaultLayout(string $name, $concrete, bool $shared = false): DefinitionInterface
    {
        return $this->delegate->add($this->getVaultLayoutServiceName($name), $concrete, $shared);
    }

    public function getVaultLayoutNames(): array
    {
        return $this->getServiceNamesWithPrefix(static::PREFIX_VAULT_LAYOUT);
    }


    protected function getConflictHandlerServiceName(string $name): string
    {
        return static::PREFIX_CONFLICT_HANDLER . $name;
    }

    protected function getIndexBuilderServiceName(string $name): string
    {
        return static::PREFIX_INDEX_BUILDER . $name;
    }

    protected function getIndexMergerServiceName(string $name): string
    {
        return static::PREFIX_INDEX_MERGER . $name;
    }

    protected function getLockAdapterServiceName(string $name): string
    {
        return static::PREFIX_LOCK_ADAPTER . $name;
    }

    protected function getOperationListBuilderServiceName(string $name): string
    {
        return static::PREFIX_OPERATION_LIST_BUILDER . $name;
    }

    protected function getStorageAdapterServiceName(string $name): string
    {
        return static::PREFIX_STORAGE_ADAPTER . $name;
    }

    protected function getVaultLayoutServiceName(string $name): string
    {
        return static::PREFIX_VAULT_LAYOUT . $name;
    }

    /**
     * Registers a factory for a type of service.
     *
     * @param string $type
     * @param string $configurationKey
     */
    protected function registerServiceFactory(string $type, string $configurationKey = null): void
    {
        $this->delegate->add($type, function(Configuration $configuration) use ($configurationKey, $type) {

            $array = $configuration->getArrayCopy();
            $configurationKey = $configurationKey ?: $type;

Consider using a different name than the imported variable $configurationKey, or did you forget to import by reference?

            if (!array_key_exists($configurationKey, $array))
            {
                throw new \LogicException("Unknown config key: {$configuration}");
            }

            return $this->delegate->get("{$type}.{$array[$configurationKey]}");

        })->withArgument('configuration');
    }

    /**
     * Registers a factory for a type of vault-specific module.
     *
     * @param string $type
     * @param string $vaultConfigurationKey
     */
    protected function registerVaultServiceFactory(string $type, string $vaultConfigurationKey = null): void
    {
        $this->delegate->add($type, function(Vault $vault) use ($type, $vaultConfigurationKey) {

            $array = $vault->getVaultConfiguration()->getArrayCopy();
            $vaultConfigurationKey = $vaultConfigurationKey ?: $type;

Consider using a different name than the imported variable $vaultConfigurationKey, or did you forget to import by reference?

            if (!array_key_exists($vaultConfigurationKey, $array))
            {
                throw new \LogicException("Unknown vault config key: {$vaultConfigurationKey}");
            }

            return $this->delegate->get("{$type}.{$array[$vaultConfigurationKey]}");

        })->withArgument('vault');
    }

    /**
     * Builds and returns list of added service names starting with a given prefix.
     *
     * @param string $prefix
     * @return string[]
     */
    protected function getServiceNamesWithPrefix(string $prefix): array
    {
        return array_map(

            // remove prefix
            function(string $alias) use ($prefix) {
                return substr($alias, strlen($prefix));
            },

            array_filter(

                // search in all registered services
                $this->delegate->getProvidedServiceNames(),

                // only service names with given prefix
                function(string $alias) use ($prefix) {
                    return substr($alias, 0, strlen($prefix)) === $prefix;
                }
            )
        );
    }
}