Class Iterator

MvcCore\Ext\Models\Db\Readers\Streams\Iterator implements MvcCore\Ext\Models\Db\Readers\Streams\IIterator, Iterator, Countable

Namespace: MvcCore\Ext\Models\Db\Readers\Streams
Located at ext-model-db/src/MvcCore/Ext/Models/Db/Readers/Streams/Iterator.php

Methods summary
`public`	# `__construct( MvcCore\Ext\Models\Db\Readers\IStream $reader, string $completerName, array $completerArguments )` Internal constructor to create stream iterator. Internal constructor to create stream iterator. Parameters `$reader` `$completerName` `$completerArguments`
`public MvcCore\Ext\Models\Db\Readers\Stream`	# `GetReader( )` Returns `MvcCore\Ext\Models\Db\Readers\Stream` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\Readers\Streams\IIterator::GetReader()`
`public MvcCore\Ext\Models\Db\Statement`	# `GetStatement( )` Returns `MvcCore\Ext\Models\Db\Statement` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\Readers\Streams\IIterator::GetStatement()`
`public MvcCore\Ext\Models\Db\Connection`	# `GetConnection( )` Returns `MvcCore\Ext\Models\Db\Connection` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\Readers\Streams\IIterator::GetConnection()`
`public`	# `Close( )` Inheritdocs Implementation of `MvcCore\Ext\Models\Db\Readers\Streams\IIterator::Close()`
`protected`	# `prepareInstances( array & $completerArguments )` Prepare instance completer internal properties. Prepare instance completer internal properties. Parameters `$completerArguments`
`protected`	# `prepareArrays( array & $completerArguments )` Prepare array completer internal properties. Prepare array completer internal properties. Parameters `$completerArguments`
`protected`	# `prepareObjects( array & $completerArguments )` Prepare objects completer internal properties. Prepare objects completer internal properties. Parameters `$completerArguments`
`protected`	# `prepareArraysAndObjects( array & $completerArguments )` Prepare arrays or objects completer internal properties. Prepare arrays or objects completer internal properties. Parameters `$completerArguments`
`protected`	# `prepareScalars( array & $completerArguments )` Prepare scalars completer internal properties. Prepare scalars completer internal properties. Parameters `$completerArguments`
`protected`	# `prepareAny( array & $completerArguments )` Prepare any types completer internal properties. Prepare any types completer internal properties. Parameters `$completerArguments`
`protected array`	# `toInstances( integer\|float\|string\|boolean $rawKey, array & $rawRow )` Instances result value completer. Instances result value completer. Parameters `$rawKey` `$rawRow` Returns array
`protected array`	# `toArrays( integer\|float\|string\|boolean $rawKey, array & $rawRow )` Arrays result value completer. Arrays result value completer. Parameters `$rawKey` `$rawRow` Returns array
`protected array`	# `toObjects( integer\|float\|string\|boolean $rawKey, array & $rawRow )` Objects result value completer. Objects result value completer. Parameters `$rawKey` `$rawRow` Returns array
`protected array`	# `toScalars( integer\|float\|string\|boolean $rawKey, array & $rawRow )` Scalars result value completer. Scalars result value completer. Parameters `$rawKey` `$rawRow` Returns array
`protected array`	# `toAny( integer\|float\|string\|boolean $rawKey, array & $rawRow )` Any types result value completer. Any types result value completer. Parameters `$rawKey` `$rawRow` Returns array
`public`	# `rewind( )` Called once before foreach loop execution. Called once before foreach loop execution. Implementation of `Iterator::rewind()`
`public mixed`	# `current( )` Called each foreach loop execution, returning foreach value. Called each foreach loop execution, returning foreach value. Returns mixed Implementation of `Iterator::current()`
`public integer\|float\|string\|boolean`	# `key( )` Called each foreach loop execution, returning foreach key. Called each foreach loop execution, returning foreach key. Returns integer\|float\|string\|boolean Implementation of `Iterator::key()`
`public`	# `next( )` Called before each foreach loop execution to move internal values to next step. Called before each foreach loop execution to move internal values to next step. Implementation of `Iterator::next()`
`public boolean`	# `valid( )` Called before each foreach loop execution (after `next()` function) to continue in loop or not. Called before each foreach loop execution (after `next()` function) to continue in loop or not. Returns boolean Implementation of `Iterator::valid()`
`public integer`	# `count( )` The number of all items in the stream iterator. It is only available after the first iterator loop is executed. The number of all items in the stream iterator. It is only available after the first iterator loop is executed. Returns integer Throws RuntimeException Implementation of `Countable::count()`

Constants inherited from MvcCore\Ext\Models\Db\Readers\Streams\IIterator
`COMPLETER_ANY, COMPLETER_ARRAYS, COMPLETER_INSTANCES, COMPLETER_OBJECTS, COMPLETER_SCALARS`

Properties summary
`protected MvcCore\Ext\Models\Db\Readers\Stream\|MvcCore\Ext\Models\Db\Readers\IStream`	`$reader` Stream reader object. Stream reader object.	#
`protected PDOStatement`	`$providerStatement` Statement object. Statement object.	#
`protected ReflectionMethod`	`$executeMethod` Stream reader execute method to rewind iterator. Stream reader execute method to rewind iterator.	#
`protected string`	`$completerMethod` Row completer method to complete result item. Row completer method to complete result item.	#
`protected stdClass`	`$completerProps` Completer local properties prepared once in constructor. Completer local properties prepared once in constructor.	#
`protected integer\|null`	`$index` Internal iterator index. Internal iterator index.	# `NULL`
`protected boolean`	`$valid` Internal boolean about to continue in loop execution. Internal boolean about to continue in loop execution.	# `FALSE`
`protected integer\|float\|string\|boolean\|null`	`$resultKey` Result loop key from completer method. Result loop key from completer method.	# `NULL`
`protected mixed`	`$resultValue` Result loop value from completer method. Result loop value from completer method.	# `NULL`

Classes

Interfaces

Traits

Exceptions

Functions

Class Iterator

Parameters

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Returns

Inheritdocs

Implementation of

Inheritdocs

Implementation of

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Implementation of

Returns

Implementation of

Returns

Throws

Implementation of