Spaark\CompositeUtils\Model\Collection\AbstractCollection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

69.23%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	size()	0	1	?
A	count()	0	4	1
A	empty()	0	4	1
A	map()	0	7	2
A	contains()	0	12	3

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <emily@emilyshepherd.me>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <emily@emilyshepherd.me>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Model\Collection;

/**
 * Represents an abstract collection of items
 *
 * @generic ValueType
 */
abstract class AbstractCollection
    implements \ArrayAccess, \IteratorAggregate, \Countable

The implements keyword must be on the same line as the class name

{
    /**
     * Returns the size of the collection
     *
     * @return int The size of the collection
     */
    abstract public function size() : int;

    /**
     * Returns how many elements are in the Collection
     *
     * @return int The number of elements in the Collection
     */
    public function count()
    {
        return $this->size();
    }

    /**
     * Checks if the Collection is empty
     *
     * @return boolean True if the element is empty
     */
    public function empty()
    {
        return $this->size() === 0;
    }

    /**
     * Basic implementation of contains
     *
     * Should be overridden by datatype-specific implementations for
     * speed improvements
     *
     * @param ValueType $searchFor The key to search for
     * @return boolean
     */
    public function contains($searchFor) : bool
    {
        foreach ($this as $item)
        {
            if ($item === $searchFor)
            {
                return true;
            }
        }

        return false;
    }

    public function map(callable $cb)
    {
        foreach ($this as $key => $value)
        {
            $cb($key, $value);
        }
    }
}