php-basics/src/InterfaceTraits/IteratorAggregate.php

53 lines
1.4 KiB
PHP
Raw Normal View History

2023-11-15 12:01:40 +01:00
<?php
/**
* Useful PHP Basics
* Copyright (C) 2023 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
2023-11-18 18:13:51 +01:00
namespace OCC\Basics\InterfaceTraits;
2023-11-15 12:01:40 +01:00
use ArrayIterator;
/**
* A generic implementation of the IteratorAggregate interface.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package opencultureconsulting/basics
2024-01-22 18:45:51 +01:00
*
* @phpstan-require-implements \IteratorAggregate
2023-11-15 12:01:40 +01:00
*/
2024-01-22 18:45:51 +01:00
trait IteratorAggregate
2023-11-15 12:01:40 +01:00
{
/**
* Holds the iterable data.
*/
private array $data = [];
/**
* Retrieve an external iterator.
* @see \IteratorAggregate::getIterator()
*
2023-11-18 16:53:42 +01:00
* @return ArrayIterator
2023-11-15 12:01:40 +01:00
*/
public function getIterator(): ArrayIterator
{
return new ArrayIterator($this->data);
}
}