GenericCollections\Abstracts\AbstractMap

Complexity

Total Complexity

36

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	2

18 Methods

Rating	Name	Duplication	Size	Complexity
A	containsKey()	0	4	2
A	containsValue()	0	4	1
A	get()	0	4	2
A	getOrDefault()	0	14	4
A	keys()	0	4	1
B	put()	0	27	5
A	putAll()	0	6	2
A	putIfAbsent()	0	9	2
A	remove()	0	8	2
A	removeExact()	0	13	3
A	replace()	0	4	2
A	replaceExact()	0	15	4
A	keysSet()	0	4	1
A	valuesCollection()	0	4	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	4	1
A	offsetUnset()	0	4	1

<?php namespace GenericCollections\Abstracts;

use GenericCollections\Collection;
use GenericCollections\Interfaces\MapInterface;
use GenericCollections\Internal\DataArray;
use GenericCollections\Set;

abstract class AbstractMap extends DataArray implements MapInterface, \ArrayAccess
{
    public function containsKey($key)
    {
        return $this->checkKeyType($key) && array_key_exists($key, $this->data);
    }

    public function containsValue($value)
    {
        return in_array($value, $this->data, $this->optionComparisonIsIdentical());
    }

    public function get($key)
    {
        return $this->containsKey($key) ? $this->data[$key] : null;
    }

    public function getOrDefault($key, $default)
    {
        if ($this->containsKey($key)) {
            return $this->data[$key];
        }
        if (null !== $default && ! $this->checkValueType($default)) {
            throw new \InvalidArgumentException(
                'The default value provided for '
                . get_class($this) . '::getOrDefault is not a valid type,'
                . ' expected ' . $this->getKeyType() . '.'
            );
        }
        return $default;
    }

    public function keys()
    {
        return array_keys($this->data);
    }

    public function put($key, $value)
    {
        if (! $this->checkKeyType($key)) {
            throw new \InvalidArgumentException(
                'The key provided for ' . get_class($this)
                . '::put is not a valid type,'
                . ' expected ' . $this->getKeyType() . '.'
            );
        }
        if (! $this->checkValueType($value)) {
            throw new \InvalidArgumentException(
                'The value provided for ' . get_class($this)
                . '::put is not a valid type,'
                . ' expected ' . $this->getValueType() . '.'
            );
        }
        if ($this->optionUniqueValues() and $this->containsValue($value)) {

Using logical operators such as and instead of && is generally not recommended.

            throw new \InvalidArgumentException(
                'The value provided for ' . get_class($this)
                . '::put is not unique,'
                . ' this map does not allow duplicated values.'
            );
        }
        $previous = $this->get($key);
        $this->data[$key] = $value;
        return $previous;
    }

    public function putAll(array $values)
    {
        foreach ($values as $key => $value) {
            $this->put($key, $value);
        }
    }

    public function putIfAbsent($key, $value)
    {
        $current = $this->get($key);
        if (null !== $current) {
            return $current;
        }
        $this->put($key, $value);
        return null;
    }

    public function remove($key)
    {
        $previous = $this->get($key);
        if ($previous !== null) {
            unset($this->data[$key]);
        }
        return $previous;
    }

    public function removeExact($key, $value)
    {
        $changed = false;
        $previous = $this->get($key);
        $isequal = ($this->optionComparisonIsIdentical())
            ? ($previous === $value)
            : ($previous == $value);
        if ($isequal) {
            unset($this->data[$key]);
            $changed = true;
        }
        return $changed;
    }

    public function replace($key, $value)
    {
        return ($this->containsKey($key)) ? $this->put($key, $value) : null;
    }

    public function replaceExact($key, $current, $replacement)
    {
        if (! $this->containsKey($key)) {
            return false;
        }
        $previous = $this->get($key);
        $isequal = ($this->optionComparisonIsIdentical())
            ? ($previous === $current)
            : ($previous == $current);
        if ($isequal) {
            $this->put($key, $replacement);
            return true;
        }
        return false;
    }

    public function keysSet()
    {
        return new Set($this->getKeyType(), $this->keys());
    }

    public function valuesCollection()
    {
        return new Collection($this->getValueType(), $this->toArray());
    }

    /*
     * Implementations from \ArrayAccess
     */
    
    /** @inheritdoc */
    public function offsetExists($offset)
    {
        return $this->containsKey($offset);
    }

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

    /** @inheritdoc */
    public function offsetSet($offset, $value)
    {
        $this->put($offset, $value);
    }

    /** @inheritdoc */
    public function offsetUnset($offset)
    {
        $this->remove($offset);
    }
}