Graze\DataStructure\Collection\CollectionInterface

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
	add()	0	1	?
	contains()	0	1	?
	getAll()	0	1	?
	filter()	0	1	?
	map()	0	1	?
	reduce()	0	1	?
	sort()	0	1	?
	sortOn()	0	1	?

<?php
/*
 * This file is part of Graze DataStructure
 *
 * Copyright (c) 2014 Nature Delivered Ltd. <http://graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @see  http://github.com/graze/data-structure/blob/master/LICENSE
 * @link http://github.com/graze/data-structure
 */

namespace Graze\DataStructure\Collection;

use Countable;
use Graze\Sort;
use IteratorAggregate;

interface CollectionInterface extends Countable, IteratorAggregate
{
    /**
     * @param mixed $value
     *
     * @return CollectionInterface
     */
    public function add($value);

    /**
     * @param mixed $value
     *
     * @return bool
     */
    public function contains($value);

    /**
     * return array.
     */
    public function getAll();

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.

    /**
     * @param callable $fn
     *
     * @return CollectionInterface
     */
    public function filter(callable $fn);

    /**
     * @param callable $fn
     *
     * @return mixed[]
     */
    public function map(callable $fn);

    /**
     * @param callable $fn
     * @param mixed $initial
     *
     * @return mixed
     */
    public function reduce(callable $fn, $initial = null);

    /**
     * @link http://php.net/manual/en/function.usort.php
     *
     * @param callable $fn
     *
     * @return CollectionInterface
     */
    public function sort(callable $fn);

    /**
     * @param callable $fn
     * @param int $order
     *
     * @return CollectionInterface
     */
    public function sortOn(callable $fn, $order = Sort\ASC);
}