Mcneely\Core\Traits\IteratorTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	key()	0	7	1
A	IteratorTrait_unwrap()	0	5	1
A	rewind()	0	10	1
A	next()	0	10	1
A	valid()	0	7	1
A	current()	0	7	1

<?php

declare(strict_types=1);

namespace Mcneely\Core\Traits;

use Generator;
use Iterator;
use Mcneely\Core\CoreObject;

/**
 * Trait IteratorTrait.
 *
 * @package Mcneely\Core\Traits
 *
 * @method mixed setCoreObject_CoreTrait($object = null)
 * @method CoreObject CoreTrait_getCoreObject()
 * @method mixed fireEvents_CoreTrait($eventClassObject, $eventImmediateClass, $eventMethod, $eventTrait)
 */
trait IteratorTrait
{
    public function key(): string
    {
        $this->CoreTrait_fireEvents($this, __CLASS__, __METHOD__, __TRAIT__);

It seems like CoreTrait_fireEvents() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this
            ->IteratorTrait_unwrap()
            ->key()
            ;
    }

    protected function IteratorTrait_unwrap(): Iterator
    {
        return $this

The expression return $this->CoreTrait_getCoreObject()->unWrap(Iterator::class, Generator::class) could return the type Traversable which includes types incompatible with the type-hinted return Iterator. Consider adding an additional type-check to rule them out.

            ->CoreTrait_getCoreObject()
            ->unWrap(Iterator::class, Generator::class)
            ;
    }

    public function current()
    {
        $this->CoreTrait_fireEvents($this, __CLASS__, __METHOD__, __TRAIT__);

        return $this
            ->IteratorTrait_unwrap()
            ->current()
            ;
    }

    public function next(): self
    {
        $this->CoreTrait_fireEvents($this, __CLASS__, __METHOD__, __TRAIT__);

        $this
            ->IteratorTrait_unwrap()
            ->next()
        ;

        return $this;
    }

    public function valid(): bool
    {
        $this->CoreTrait_fireEvents($this, __CLASS__, __METHOD__, __TRAIT__);

        return $this
            ->IteratorTrait_unwrap()
            ->valid()
            ;
    }

    public function rewind(): self
    {
        $this->CoreTrait_fireEvents($this, __CLASS__, __METHOD__, __TRAIT__);

        $this
            ->IteratorTrait_unwrap()
            ->rewind()
        ;

        return $this;
    }
}