Biscolab\UpDown\Abstracts\AbstractCollection

Complexity

Total Complexity

23

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setItems()	0	10	4
A	addItem()	0	7	1
A	getLastIndex()	0	6	2
A	count()	0	4	1
A	current()	0	4	1
A	seek()	0	6	2
A	last()	0	4	1
A	position()	0	4	1
A	first()	0	4	1
A	get()	0	4	2
A	parseItem()	0	8	3
A	toArray()	0	4	1
A	__toString()	0	4	1
A	toJson()	0	4	1

<?php
/**
 * Copyright (c) 2019 - present
 * updown - AbstractCollection.php
 * author: Roberto Belotti - roby.belotti@gmail.com
 * web : robertobelotti.com, github.com/biscolab
 * Initial version created on: 15/2/2019
 * MIT license: https://github.com/biscolab/updown-php/blob/master/LICENSE
 */

namespace Biscolab\UpDown\Abstracts;

/**
 * Class AbstractCollection
 * @package Biscolab\UpDown\Abstracts
 */
abstract class AbstractCollection
{

    /**
     * @var array
     */
    protected $items = [];

    /**
     * @var int
     */
    protected $index = 0;

    /**
     * @var string
     */
    protected $children_class = null;

    /**
     * AbstractCollection constructor.
     *
     * @param null|array $items
     */
    public function __construct(?array $items = [])
    {

        $this->setItems($items);
    }

    /**
     * @param array $items
     *
     * @return AbstractCollection
     */
    protected function setItems(?array $items = [])
    {

        if (is_array($items) && count($items)) {
            foreach ($items as $item) {
                $this->addItem($item);
            }
        }

        return $this;
    }

    /**
     * @param $item
     *
     * @return AbstractCollection
     */
    public function addItem($item)
    {

        $item = $this->parseItem($item);
        array_push($this->items, $item);

        return $this;
    }

    /**
     * @param $item
     *
     * @return mixed
     */
    protected function parseItem($item)
    {

        if ($this->children_class && !$item instanceof $this->children_class) {
            $item = new $this->children_class($item);
        }

        return $item;
    }

    /**
     * @return string
     */
    public function toJson(): string
    {

        return json_encode($this->toArray());
    }

    /**
     * @return array
     */
    public function toArray(): array
    {

        return $this->items;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {

        return implode(',', $this->toArray());
    }

    /**
     * Return the current position of the index
     *
     * @return int
     */
    public function position(): int
    {

        return $this->index;
    }

    /**
     * Return the current object
     *
     * @return mixed|null
     */
    public function current()
    {

        return $this->get($this->index);
    }

    /**
     * @param $index
     *
     * @return mixed|null
     */
    public function get(int $index)
    {

        return isset($this->items[$index]) ? $this->items[$index] : null;
    }

    /**
     * Move index to first position and return current element
     *
     * @return mixed|null
     */
    public function first()
    {

        return $this->seek();
    }

    /**
     * Move the index at the specified position
     *
     * @param int|null $index
     *
     * @return mixed|null
     */
    public function seek(?int $index = 0)
    {

        $this->index = ($index < $this->count()) ? $index : $this->getLastIndex();

        return $this->get(intval($this->index));
    }

    /**
     * @return int
     */
    public function count(): int
    {

        return count($this->items);
    }

    /**
     * @return int
     */
    public function getLastIndex(): int
    {

        $last_position = $this->count() - 1;

        return ($last_position) < 0 ? 0 : $last_position;
    }

    /**
     * Move index at the end of collection and return current element
     *
     * @return mixed|null
     */
    public function last()
    {

        return $this->seek($this->getLastIndex());
    }

}