Itafroma\Zork\State\AbstractCollection

Complexity

Total Complexity

5

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	6	1
A	get()	0	4	2
A	set()	0	6	1
A	exists()	0	4	1

<?php

/**
 * @file
 * Base implementation of state collections.
 */

namespace Itafroma\Zork\State;

abstract class AbstractCollection implements CollectionInterface
{
    protected $atoms = [];

    /**
     * Creates a new atom within the collection.
     *
     * @param string $name The name of the atom to create.
     * @return mixed The atom created.
     */
    public function create($name)
    {
        $this->atoms[$name] = null;

        return $this->atoms[$name];
    }

    /**
     * Retrieves an atom by name.
     *
     * @param string $name The name of the atom to retrieve.
     * @return mixed The atom retrieved if it exists, false otherwise.
     */
    public function get($name)
    {
        return isset($this->atoms[$name]) ? $this->atoms[$name] : false;
    }

    /**
     * Adds a value to the collection.
     *
     * @param string $name The name of the atom to add to the collection.
     * @param string $value The value to add to the collection.
     * @return mixed The value added to the collection.
     */
    public function set($name, $value)
    {
        $this->atoms[$name] = $value;

        return $value;
    }

    /**
     * Checks to see if an atom already exists within the collection.
     *
     * @param string $name The name of the atom.
     * @return boolean True if the atom exists, false otherwise.
     */
    public function exists($name)
    {
        return isset($this->atoms[$name]);
    }
}