Download the PHP package hoa/iterator without Composer
On this page you can find all versions of the php package hoa/iterator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package iterator
Short Description The Hoa\Iterator library.
License BSD-3-Clause
Homepage https://hoa-project.net/
Informations about the package iterator
Hoa is a modular, extensible and
structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.
Hoa\Iterator
This library provides a set of useful iterator (compatible with PHP iterators). Existing PHP iterators have been updated to get new features and prior PHP versions compatibility.
Installation
With Composer, to include this library into
your dependencies, you need to
require hoa/iterator
:
For more installation procedures, please read the Source page.
Testing
Before running the test suites, the development dependencies must be installed:
Then, to run all the test suites:
For more information, please read the contributor guide.
Quick usage
We propose a quick overview of all iterators.
The One
Hoa\Iterator\Iterator
defines the basis of an iterator. It extends
Iterator
.
External iterator
Hoa\Iterator\Aggregate
allows a class to use an external iterator through the
getIterator
method. It extends
IteratorAggregate
Traversable to iterator
Hoa\Iterator\IteratorIterator
transforms anything that is
traversable into an iterator. It extends
IteratorIterator
.
Iterator of iterators
Hoa\Iterator\Outer
represents an iterator that iterates over iterators. It
extends OuterIterator
.
Mock
Hoa\Iterator\Mock
represents an empty iterator. It extends
EmptyIterator
.
Seekable
Hoa\Iterator\Seekable
represents an iterator that can be seeked. It extends
SeekableIterator
.
Map
Hoa\Iterator\Map
allows to iterate an array. It extends
ArrayIterator
.
Filters
Hoa\Iterator\Filter
and Hoa\Iterator\CallbackFilter
allows to filter the
content of an iterator. It extends
FilterIterator
and
CallbackFilterIterator
.
Also, Hoa\Iterator\RegularExpression
allows to filter based on a regular
expression.
Limit
Hoa\Iterator\Limit
allows to iterate n elements of an iterator starting from
a specific offset. It extends LimitIterator
.
Infinity
Hoa\Iterator\Infinite
allows to iterate over and over again the same iterator.
It extends InfiniteIterator
.
Also, Hoa\Iterator\NoRewind
is an iterator that does not rewind. It extends
NoRewindIterator
.
Repeater
Hoa\Iterator\Repeater
allows to repeat an iterator n times.
Counter
Hoa\Iterator\Counter
is equivalent to a for($i = $from, $i < $to, $i += $step)
loop.
Union of iterators
Hoa\Iterator\Append
allows to iterate over iterators one after another. It
extends AppendIterator
.
Multiple
Hoa\Iterator\Multiple
allows to iterate over several iterator at the same
times. It extends MultipleIterator
.
Demultiplexer
Hoa\Iterator\Demultiplexer
demuxes result from another iterator. This iterator
is somehow the opposite of the Hoa\Iterator\Multiple
iterator.
File system
Hoa\Iterator\Directory
and Hoa\Iterator\FileSystem
allow to iterate the file
system where files are represented by instances of Hoa\Iterator\SplFileInfo
.
They respectively extend
DirectoryIterator
,
FilesystemIterator
and
SplFileInfo
.
Also, the Hoa\Iterator\Glob
allows to iterator with the glob strategy. It
extends GlobIterator
. Thus:
Look ahead
Hoa\Iterator\Lookahead
allows to look ahead for the next element:
The Hoa\Iterator\Lookbehind
also exists and allows to look behind for the
previous element.
Buffer
Hoa\Iterator\Buffer
allows to move forward as usual but also backward up to a
given buffer size over another iterator:
Callback generator
Hoa\Iterator\CallbackGenerator
allows to transform any callable into an
iterator. This is very useful when combined with other iterators, for instance
with Hoa\Iterator\Limit
:
Recursive iterators
A recursive iterator is an iterator where its values is other iterators. The
most important interface is Hoa\Iterator\Recursive\Recursive
(it extends
RecursiveIterator
). Then we find (in
alphabetic order):
Hoa\Iterator\Recursive\CallbackFilter
(it extendsRecursiveCallbackFilterIterator
),Hoa\Iterator\Recursive\Directory
(it extendsRecursiveDirectoryIterator
),Hoa\Iterator\Recursive\Filter
(it extendsRecursiveFilterIterator
),Hoa\Iterator\Recursive\Iterator
(it extendsRecursiveIteratorIterator
),Hoa\Iterator\Recursive\Map
(it extendsRecursiveArrayIterator
),Hoa\Iterator\Recursive\Mock
,Hoa\Iterator\Recursive\RegularExpression
(it extendsRecursiveRegularExpression
).
Documentation
The
hack book of Hoa\Iterator
contains
detailed information about how to use this library and how it works.
To generate the documentation locally, execute the following commands:
More documentation can be found on the project's website: hoa-project.net.
Getting help
There are mainly two ways to get help:
- On the
#hoaproject
IRC channel, - On the forum at users.hoa-project.net.
Contribution
Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.
License
Hoa is under the New BSD License (BSD-3-Clause). Please, see
LICENSE
for details.