Collections\Traits\GuardTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

62.5%

Importance

Changes	3
Bugs	1	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
	isEmpty()	0	1	?
	count()	0	1	?
A	emptyGuard()	0	8	2
A	validateKeyBounds()	0	6	2
A	isBoundedKey()	0	4	2
A	validateKeyType()	0	6	2
A	validateTraversable()	0	6	3

<?php

namespace Collections\Traits;

use Collections\Exception\EmptyException;
use Collections\Exception\InvalidArgumentException;
use Collections\Exception\TypeException;

trait GuardTrait
{
    abstract function isEmpty();

It is generally recommended to explicitly declare the visibility for methods.

    abstract function count();

It is generally recommended to explicitly declare the visibility for methods.

    /**
     * Ensures that we throw the correct exception when an empty collection is found
     * @param $method
     * @throws EmptyException
     */
    protected function emptyGuard($method)
    {
        if ($this->isEmpty()) {
            throw new EmptyException(
                "{$method} cannot be called when the structure is empty"
            );
        }
    }

    /**
     * Validates if a key is withing bounds (usually only useful with vectors)
     * @param $key
     */
    protected function validateKeyBounds($key)
    {
        if (!$this->isBoundedKey($key)) {
            throw new \OutOfBoundsException("Integer key $key is out of bounds");
        }
    }

    /**
     * @param int $element
     * @return bool
     */
    protected function isBoundedKey($element)
    {
        return $element >= 0 && $element < $this->count();
    }

    /**
     * Validate if an element respects the correct type (usually only useful with vectors)
     * @param $element
     * @throws TypeException
     */
    protected function validateKeyType($element)
    {
        if (filter_var($element, FILTER_VALIDATE_INT) === false) {
            throw new TypeException('Only integer keys may be used with ' . (get_class($this)));
        }
    }

    protected function validateTraversable($traversable)
    {
        if (!is_array($traversable) && !$traversable instanceof \Traversable) {
            throw InvalidArgumentException::invalidTraversable();
        }
    }
}