Yiisoft\ActiveRecord\Trait\ArrayIteratorTrait

Complexity

Total Complexity

1

Size/Duplication

Total Lines	14
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getIterator()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\ActiveRecord\Trait;

use ArrayIterator;
use IteratorAggregate;

/**
 * Trait to implement {@see IteratorAggregate} interface for ActiveRecord.
 *
 * @method array getAttributes(array|null $names = null, array $except = [])
 * @see ActiveRecordInterface::getAttributes() for more info.
 */
trait ArrayIteratorTrait
{
    /**
     * Returns an iterator for traversing the attributes in the ActiveRecord.
     *
     * This method is required by the interface {@see IteratorAggregate}.
     *
     * @return ArrayIterator an iterator for traversing the items in the list.
     */
    public function getIterator(): ArrayIterator
    {
        $attributes = $this->getAttributes();

        return new ArrayIterator($attributes);
    }
}