Graze\DataStructure\Container\ContainerInterface

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	add()	0	1	?
	forAll()	0	1	?
	get()	0	1	?
	getAll()	0	1	?
	has()	0	1	?
	set()	0	1	?
	remove()	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\Container;

use Graze\DataStructure\Exception\RegisteredKeyException;
use IteratorAggregate;
use ArrayAccess;

interface ContainerInterface extends IteratorAggregate, ArrayAccess
{
    /**
     * @param string $key
     * @param mixed $value
     *
     * @throws RegisteredKeyException If value with `$key` is already registered
     *
     * @return ContainerInterface
     */
    public function add($key, $value);

    /**
     * @param callable $fn
     */
    public function forAll(callable $fn);

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 string $key
     *
     * @return mixed
     */
    public function get($key);

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

    /**
     * @param string $key
     *
     * @return bool
     */
    public function has($key);

    /**
     * @param string $key
     * @param mixed $value
     *
     * @return ContainerInterface
     */
    public function set($key, $value);

    /**
     * @param string $key
     *
     * @return ContainerInterface
     */
    public function remove($key);
}