Pnz\MattermostClient\Model\ModelCollectionOrdered

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	getItemsDataName()	0	1	?
A	createFromArray()	0	11	2
A	current()	0	4	1
A	key()	0	4	1
A	valid()	0	4	1
A	getOrder()	0	4	1

<?php

declare(strict_types=1);

namespace Pnz\MattermostClient\Model;

abstract class ModelCollectionOrdered extends ModelCollection
{
    /**
     * @var array
     */
    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];
    }

    /**
     * {@inheritdoc}
     */
    public function valid()
    {
        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.
     *
     * @return string
     */
    abstract protected static function getItemsDataName();
}