Pnz\MattermostClient\Model\ModelCollectionOrdered

Complexity

Total Complexity

6

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	current()	0	3	1
A	valid()	0	3	1
A	key()	0	3	1
A	getOrder()	0	3	1
A	createFromArray()	0	10	2

<?php

declare(strict_types=1);

namespace Pnz\MattermostClient\Model;

abstract class ModelCollectionOrdered extends ModelCollection
{
    /**
     * @var string[]
     */
    protected $order = [];

    /**
     * {@inheritdoc}
     */
    public static function createFromArray(array $data)
    {
        $collection = new static();

        foreach ($data[static::getItemsDataName()] as $itemId => $itemData) {
            $collection->items[$itemId] = $collection->createItem($itemData);
        }
        $collection->order = $data['order'];

        return $collection;
    }

    /**
     * {@inheritdoc}
     */
    public function current()
    {
        return $this->items[$this->order[$this->key]];
    }

    /**
     * {@inheritdoc}
     */
    public function key()
    {
        return $this->order[$this->key];
    }

    public function valid(): bool
    {
        return $this->key < \count($this->order);
    }

    /**
     * @return string[]
     */
    public function getOrder(): array
    {
        return $this->order;
    }

    /**
     * Returns the name of the data containing the items to be sorted.
     */
    abstract protected static function getItemsDataName(): string;
}