Class EntityCollectionIterator

Class for conveniently iterating through collections of entities beyond the ones which have been loaded from the server.

Represents a range 0-n, where n is the number of entities that the query would have returned if no limit was set. Only a part of this range is loaded at a time, so iterating may cause additional HTTP requests to be issued.

PipelinerSales\ApiClient\EntityCollectionIterator implements SeekableIterator

Namespace: PipelinerSales\ApiClient
Located at PipelinerSales/ApiClient/EntityCollectionIterator.php

Methods summary
`public`	# `__construct( PipelinerSales\ApiClient\Repository\RepositoryInterface $repository, PipelinerSales\ApiClient\EntityCollection $collection )` Parameters `$repository` repository for loading additional entities `$collection` initial collection of already loaded entities
`public PipelinerSales\ApiClient\Entity`	# `current( )` Returns `PipelinerSales\ApiClient\Entity` Implementation of `Iterator::current()`
`public integer`	# `key( )` Returns `integer` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public boolean`	# `dataAvailable( )` True if data for the current position has been loaded from the server and is locally available. True if data for the current position has been loaded from the server and is locally available. Returns `boolean`
`public boolean`	# `nextDataAvailable( )` True if data for the next position has been loaded from the server and is locally available. This is useful in foreach loops to determine whether the next iteration will issue a HTTP request. True if data for the next position has been loaded from the server and is locally available. This is useful in foreach loops to determine whether the next iteration will issue a HTTP request. Returns `boolean`
`public boolean`	# `atEnd( )` True if the current position is the last position within the range. True if the current position is the last position within the range. Returns `boolean`
`public`	# `seek( $position )` Implementation of `SeekableIterator::seek()`

Namespaces

Classes

Interfaces

Exceptions

Class EntityCollectionIterator

Parameters

Returns

Implementation of

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Returns

Returns

Returns

Implementation of