TQ\Vcs\StreamWrapper\RepositoryRegistry

Complexity

Total Complexity

9

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addRepository()	0	5	1
A	hasRepository()	0	4	1
A	getRepository()	0	8	2
A	tryGetRepository()	0	9	2
A	count()	0	4	1
A	addRepositories()	0	7	2

<?php
/*
 * Copyright (C) 2017 by TEQneers GmbH & Co. KG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Git Stream Wrapper for PHP
 *
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */

namespace TQ\Vcs\StreamWrapper;
use TQ\Vcs\Repository\RepositoryInterface;

/**
 * Manages multiples repositories by keys
 *
 * @author     Stefan Gehrig <gehrigteqneers.de>
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */
class RepositoryRegistry implements \Countable
{
    /**
     * The repository map
     *
     * @var array
     */
    protected $map  = array();

    /**
     * Adds a single repository
     *
     * @param   string               $key        The key
     * @param   RepositoryInterface           $repository The repository
     * @return  RepositoryRegistry
     */
    public function addRepository($key, RepositoryInterface $repository)
    {
        $this->map[$key]    = $repository;
        return $this;
    }

    /**
     * Adds multiple repositories
     *
     * @param   array      $repositories    The repositories (key => repository)
     * @return  RepositoryRegistry
     */
    public function addRepositories(array $repositories)
    {
        foreach ($repositories as $key => $repository) {
            $this->addRepository($key, $repository);
        }
        return $this;
    }

    /**
     * Returns true if the repository is registered in the map
     *
     * @param   string      $key        The key
     * @return  boolean
     */
    public function hasRepository($key)
    {
        return isset($this->map[$key]);
    }

    /**
     * Returns the repository if it is registered in the map, throws exception otherwise
     *
     * @param   string      $key        The key
     * @return  RepositoryInterface
     * @throws  \OutOfBoundsException   If the key does not exist
     */
    public function getRepository($key)
    {
        $repository = $this->tryGetRepository($key);
        if ($repository === null) {
            throw new \OutOfBoundsException($key.' does not exist in the registry');
        }
        return $repository;
    }

    /**
     * Returns the repository if it is registered in the map, NULL otherwise
     *
     * @param   string      $key        The key
     * @return  RepositoryInterface|null
     */
    public function tryGetRepository($key)
    {
        if ($this->hasRepository($key)) {
            return $this->map[$key];
        } else {
            return null;
        }

    }

    /**
     * Count elements of an object
     *
     * @link    http://php.net/manual/en/countable.count.php
     * @return  integer     The custom count as an integer
     */
    public function count()
    {
        return count($this->map);
    }
}