Archivr\Configuration

Complexity

Total Complexity

23

Size/Duplication

Total Lines	219
Duplicated Lines	1.83 %

Coupling/Cohesion

Components	3
Dependencies	2

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getPath()	0	4	1
A	setPath()	0	11	2
A	getExclude()	0	4	1
A	setExclude()	0	6	1
A	addExclusion()	0	6	1
A	getIdentity()	0	4	1
A	setIdentity()	0	6	1
A	getVaults()	0	4	1
A	hasVault()	0	4	1
A	getVaultByTitle()	0	9	2
A	addVault()	0	11	2
C	exchangeArray()	4	38	7
A	getArrayCopy()	0	11	1

<?php

namespace Archivr;

use Archivr\Exception\Exception;
use Zend\Stdlib\ArraySerializableInterface;

class Configuration implements ArraySerializableInterface
{
    /**
     * The local base path of the archive.
     *
     * @var string
     */
    protected $path;

    /**
     * Set of excluded paths.
     *
     * @var string[]
     */
    protected $exclude = [];

    /**
     * Identity to be visible in synchronization log.
     *
     * @var string
     */
    protected $identity;

    /**
     * Map of vault configurations by identifier.
     *
     * @var VaultConfiguration[]
     */
    protected $vaults = [];

    public function __construct(string $localPath = './')
    {
        $this->setPath($localPath);
    }

    /**
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * @param string $path
     *
     * @return Configuration
     */
    public function setPath(string $path): Configuration
    {
        if (substr($path, -1) !== DIRECTORY_SEPARATOR)
        {
            $path .= DIRECTORY_SEPARATOR;
        }

        $this->path = $path;

        return $this;
    }

    /**
     * @return \string[]
     */
    public function getExclude(): array
    {
        return $this->exclude;
    }

    /**
     * @param \string[] $paths
     *
     * @return Configuration
     */
    public function setExclude(array $paths): Configuration
    {
        $this->exclude = array_values($paths);

It seems like array_values($paths) of type array<integer,object<string>> is incompatible with the declared type array<integer,string> of property $exclude.

        return $this;
    }

    /**
     * @param string $path
     *
     * @return Configuration
     */
    public function addExclusion(string $path): Configuration
    {
        $this->exclude[] = $path;

        return $this;
    }

    /**
     * @return string
     */
    public function getIdentity()
    {
        return $this->identity;
    }

    /**
     * @param string $identity
     *
     * @return Configuration
     */
    public function setIdentity(string $identity): Configuration
    {
        $this->identity = $identity;

        return $this;
    }

    /**
     * @return VaultConfiguration[]
     */
    public function getVaults(): array
    {
        return $this->vaults;
    }

    /**
     * @param string $title
     * @return bool
     */
    public function hasVault(string $title): bool
    {
        return isset($this->vaults[$title]);
    }

    /**
     * @param string $title
     *
     * @return VaultConfiguration
     */
    public function getVaultByTitle(string $title)
    {
        if (!isset($this->vaults[$title]))
        {
            throw new \InvalidArgumentException("Unknown vault configuration requested: {$title}");
        }

        return $this->vaults[$title];
    }

    /**
     * @param VaultConfiguration $configuration
     *
     * @return Configuration
     * @throws Exception
     */
    public function addVault(VaultConfiguration $configuration): Configuration
    {
        if (isset($this->vaults[$configuration->getTitle()]))
        {
            throw new Exception(sprintf('Trying to add vault with duplicate title %s.', $configuration->getTitle()));
        }

        $this->vaults[$configuration->getTitle()] = $configuration;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function exchangeArray(array $array)
    {
        if ($diff = array_diff(array_keys($array), array_keys(get_object_vars($this))))

This code seems to be duplicated across your project.

        {
            throw new \InvalidArgumentException("Invalid index(es): " . implode(',', $diff));
        }

        foreach ($array as $key => $value)
        {
            if ($key === 'vaults')
            {
                if (!is_array($value))
                {
                    throw new \InvalidArgumentException();
                }

                $this->vaults = [];

                foreach ($value as $val)
                {
                    if (!is_array($val))
                    {
                        throw new \InvalidArgumentException();
                    }

                    $vaultConfig = new VaultConfiguration('dummy');
                    $vaultConfig->exchangeArray($val);

                    $this->addVault($vaultConfig);
                }
            }
            else
            {
                // using setter to prevent skipping validation
                call_user_func([$this, 'set' . ucfirst($key)], $value);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getArrayCopy()
    {
        $return = get_object_vars($this);
        $return['vaults'] = array_values(array_map(function(VaultConfiguration $vaultConfiguration) {

            return $vaultConfiguration->getArrayCopy();

        }, $this->vaults));

        return $return;
    }
}