LM\Common\Model\ArrayObject

Complexity

Total Complexity

18

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	hasNextItem()	0	3	1
A	getSize()	0	3	1
A	setToNextItem()	0	3	1
A	checkItemsType()	0	7	2
A	serialize()	0	6	1
A	add()	0	7	1
A	toArray()	0	7	2
A	getCurrentItem()	0	6	1
A	unserialize()	0	6	1
A	__construct()	0	17	5
A	addWithkey()	0	7	1
A	get()	0	6	1

<?php

declare(strict_types=1);

namespace LM\Common\Model;

use LM\Common\Type\TypeCheckerTrait;
use Serializable;
use UnexpectedValueException;

/**
 * Object that provides the features of an array as an object.
 *
 * @deprecated
 * @todo Delete?
 */
class ArrayObject implements Serializable
{
    use TypeCheckerTrait;

The trait LM\Common\Type\TypeCheckerTrait has been deprecated.

    /** @var int */
    private $currentItemIndex;

    /** @var mixed[] */
    private $items;

    /** @var string */
    private $type;

    /**
     * @param mixed[] $items An array of items to initialise the objec with. The
     * constructor checks they are of the type $type.
     * @param string $type The type of the items of the array object.
     */
    public function __construct(array $items, string $type)
    {
        $this->items = [];
        foreach ($items as $key => $item) {
            $this->checkType($item, $type);
            if ($this->isStringType($type)) {
                $this->items[$key] = $item;
            } elseif ($this->isIntegerType($type)) {
                $this->items[$key] = $item;
            } elseif ($this->isClassOrInterfaceName($type)) {
                $this->items[$key] = $item;
            } else {
                throw new UnexpectedValueException();
            }
        }
        $this->currentItemIndex = 0;
        $this->type = $type;
    }

    /**
     * Returns a copy of the object with a value added to it.
     *
     * @param mixed $value The item to add to the array object.
     * @todo Rename to append.
     * @todo Remove $type parameter.
     */
    public function add($value, string $type = null): self

The parameter $type is not used and could be removed.

    {
        $this->checkType($value, $this->type);
        $items = $this->items;
        $items[] = $value;

        return new self($items, $this->type);
    }

    /**
     * @todo Remove type parameter.
     */
    public function checkItemsType(string $type = null): self

The parameter $type is not used and could be removed.

    {
        foreach ($this->items as $item) {
            $this->checkType($item, $this->type);
        }

        return $this;
    }

    /**
     * @todo Delete
     * @todo Rename to add.
     * @todo Remove type parameter.
     */
    public function addWithkey($key, $value, string $type): self

The parameter $type is not used and could be removed.

    {
        $this->checkType($value, $this->type);
        $items = $this->items;
        $items[$key] = $value;

        return new self($items, $this->type);
    }

    /**
     * @return bool Whether the array object's current item has a successor.
     */
    public function hasNextItem(): bool
    {
        return $this->currentItemIndex + 1 < count($this->items);
    }

    /**
     * @param string $key The key of the item.
     * @todo Remove type parameter.
     */
    public function get($key, string $type = null)

The parameter $type is not used and could be removed.

    {
        $item = $this->items[$key];
        $this->checkType($item, $this->type);

        return $item;
    }

    /**
     * @return $mixed The current item.

The doc comment $mixed at position 0 could not be parsed: Unknown type name '$mixed' at position 0 in $mixed.

     */
    public function getCurrentItem(string $class)
    {
        $currentItem = $this->items[$this->currentItemIndex];
        $this->checkType($currentItem, $class);

        return $currentItem;
    }

    /**
     * @todo Mutable object!
     */
    public function setToNextItem(): void
    {
        $this->currentItemIndex++;
    }

    /**
     * @return int The number of items the object holds.
     */
    public function getSize(): int
    {
        return count($this->items);
    }

    /**
     * @return array An array representation of the object.
     */
    public function toArray(string $type): array

The parameter $type is not used and could be removed.

    {
        foreach ($this->items as $item) {
            $this->checkType($item, $this->type);
        }

        return $this->items;
    }

    public function serialize(): string
    {
        return serialize([
            $this->currentItemIndex,
            $this->items,
            $this->type,
        ]);
    }

    public function unserialize($serialized): void
    {
        list(
            $this->currentItemIndex,
            $this->items,
            $this->type) = unserialize($serialized);
    }
}