Menu

## DocumentIterator
in package
implements Iterator

inc.ClassIterator.php : 18

Implementation of the document iterartor

##### Tags

category

  DMS

license

  GPL 2

version

  @version@

version

  Release: @package_version@

author

  Uwe Steinmann uwe@steinmann.cx

copyright

  Copyright (C) 2010-2024 Uwe Steinmann

### Table of Contents

#### Interfaces

Iterator

#### Properties

$_cache : array<string|int, mixed>
$_dms : object
$_documents : array<string|int, mixed>
$_folder : object
$_pointer : int

#### Methods

__construct() : mixed
current() : mixed
key() : mixed
next() : void
rewind() : void
valid() : bool
populate() : mixed

### Properties

#### $_cache

inc.ClassIterator.php : 42
`protected array<string|int, mixed> $_cache`

#### $_dms

inc.ClassIterator.php : 27
`protected object $_dms`

dms

#### $_documents

inc.ClassIterator.php : 32
`protected array<string|int, mixed> $_documents`

documents

#### $_folder

inc.ClassIterator.php : 22
`protected object $_folder`

folder

#### $_pointer

inc.ClassIterator.php : 37
`protected int $_pointer`

### Methods

#### __construct()

inc.ClassIterator.php : 44
`public __construct(mixed $folder) : mixed`

##### Parameters

$folder : mixed

#### current()

inc.ClassIterator.php : 69
`public current() : mixed`

#### key()

inc.ClassIterator.php : 65
`public key() : mixed`

#### next()

inc.ClassIterator.php : 61
`public next() : void`

#### rewind()

inc.ClassIterator.php : 53
`public rewind() : void`

#### valid()

inc.ClassIterator.php : 57
`public valid() : bool`

##### Return values

bool

#### populate()

inc.ClassIterator.php : 81
`private populate([mixed $orderby = "" ][, mixed $dir = "asc" ][, mixed $limit = 0 ][, mixed $offset = 0 ]) : mixed`

##### Parameters

$orderby : mixed = ""
$dir : mixed = "asc"
$limit : mixed = 0
$offset : mixed = 0

## Search results