TomPHP\HalClient\Resource\Collection

Complexity

Total Complexity

8

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	findMatching()	0	9	1
A	offsetExists()	0	4	1
A	offsetGet()	0	4	1
A	offsetSet()	0	4	1
A	offsetUnset()	0	4	1
A	count()	0	4	1
A	matches()	0	4	1
	assertItemTypesAreCorrect()	0	1	?

<?php

namespace TomPHP\HalClient\Resource;

use Assert\Assertion;
use TomPHP\HalClient\Exception\MutabilityException;

trait Collection
{
    /** @var Matchable[] */
    protected $items;

    /** @var Matchable[] */
    public function __construct(array $items)
    {
        Assertion::allIsInstanceOf($items, Matchable::class);
        $this->assertItemTypesAreCorrect($items);

        $this->items = $items;
    }

    /**
     * @param array $criteria
     *
     * @return static
     */
    public function findMatching(array $criteria)
    {
        return new static(array_values(array_filter(
            $this->items,
            function (Matchable $node) use ($criteria) {
                return $node->matches($criteria);
            }
        )));
    }

    /**
     * @return bool
     */
    public function offsetExists($offset)
    {
        return isset($this->items[$offset]);
    }

    /**
     * @return Matchable
     */
    public function offsetGet($offset)
    {
        return $this->items[$offset];
    }

    /**
     * @throws MutabilityException
     */
    public function offsetSet($offset, $value)

The parameter $offset is not used and could be removed.

The parameter $value is not used and could be removed.

    {
        throw new MutabilityException();
    }

    /**
     * @throws MutabilityException
     */
    public function offsetUnset($offset)

The parameter $offset is not used and could be removed.

    {
        throw new MutabilityException();
    }

    public function count()
    {
        return count($this->items);
    }

    public function matches($criteria)

The parameter $criteria is not used and could be removed.

    {
        return false;
    }

    abstract protected function assertItemTypesAreCorrect(array $items);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}