Mapado\RestClientSdk\Collection\Collection

Complexity

Total Complexity

16

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Test Coverage

Coverage

42.86%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	unserialize()	0	3	1
A	offsetSet()	0	6	2
A	serialize()	0	3	1
A	offsetGet()	0	3	2
A	getIterator()	0	3	1
A	offsetUnset()	0	3	1
A	count()	0	3	1
A	getTotalItems()	0	3	1
A	getExtraProperties()	0	3	1
A	offsetExists()	0	3	1
A	toArray()	0	3	1
A	__construct()	0	4	1
A	getExtraProperty()	0	4	2

<?php

namespace Mapado\RestClientSdk\Collection;

use \ArrayIterator;

/**
 * Class Collection
 *
 * @author Florent Clerc <florent.clerc@mapado.com>
 */
class Collection implements \IteratorAggregate, \Serializable, \Countable, \ArrayAccess
{
    /**
     * The elements of the collection.
     *
     * @var array
     */
    private $elements;

    /**
     * extra properties that are not the main list but linked data
     * It can be "_embed" or "_links" for HAL response
     * or "hydra:totalItems" for JSON-LD
     * or anything you want to really ("foo" is OK for exemple)
     *
     * @var array
     * @access private
     */
    private $extraProperties;

    /**
     * @param array $elements The data elements as an array.
     * @param array $extraProperties The extra properties.
     */
    public function __construct(array $elements = [], array $extraProperties = [])
    {
        $this->elements = $elements;
        $this->extraProperties = $extraProperties;
    }

    /**
     * Returns inner elements collection.
     *
     * @return array
     */
    public function toArray()
    {
        return $this->elements;
    }

    /**
     * {@inheritdoc}
     */
    public function serialize()
    {
        return serialize($this->elements);
    }

    /**
     * {@inheritdoc}
     */
    public function unserialize($values)
    {
        $this->elements = unserialize($values);
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return count($this->elements);
    }

    /**
     * Returns element count in collection.
     *
     * @return int
     */
    public function getTotalItems()
    {
        return $this->count();
    }

    /**
     * {@inheritdoc}
     */
    public function offsetSet($offset, $value)
    {
        if (is_null($offset)) {
            $this->elements[] = $value;
        } else {
            $this->elements[$offset] = $value;
        }
    }

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

    /**
     * {@inheritdoc}
     */
    public function offsetUnset($offset)
    {
        unset($this->elements[$offset]);
    }

    /**
     * {@inheritdoc}
     */
    public function offsetGet($offset)
    {
        return isset($this->elements[$offset]) ? $this->elements[$offset] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new ArrayIterator($this->elements);
    }

    /**
     * getExtraProperties
     *
     * @access public
     * @return array
     */
    public function getExtraProperties()
    {
        return $this->extraProperties;
    }

    /**
     * return the value of an extra property
     *
     * @param string $key
     * @access public
     * @return mixed
     */
    public function getExtraProperty($key)
    {
        if (isset($this->extraProperties[$key])) {
            return $this->extraProperties[$key];
        }
    }
}