1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?php
/**
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
| |
| Copyright (C) The Roundcube Dev Team |
| |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
| See the README file for a full license statement. |
| |
| PURPOSE: |
| Class representing an address directory result set |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
*/
/**
* Roundcube result set class
*
* Representing an address directory result set.
* Implements Iterator and can thus be used in foreach() loops.
*
* @package Framework
* @subpackage Addressbook
*/
class rcube_result_set implements Iterator, ArrayAccess
{
/**
* @var int The number of total records. Note that when only a subset of records is requested,
* this number may be higher than the number of data records in this result set.
*/
public $count = 0;
/**
* @var int When a subset of the total records is requested, $first gives the index into the total record
* set from that the data records in this result set start. This is normally a multiple of the
* user-configured page size.
*/
public $first = 0;
/**
* @var bool True if the results are from an addressbook that does not support listing all records but
* requires the search function to be used.
*/
public $searchonly = false;
/**
* @var array The data records of the result set. May be a subset of the total records, e.g. for one page.
*/
public $records = [];
private $current = 0;
function __construct($count = 0, $first = 0)
{
$this->count = (int) $count;
$this->first = (int) $first;
}
public function add($rec)
{
$this->records[] = $rec;
}
public function iterate()
{
$current = $this->current();
$this->current++;
return $current;
}
public function first()
{
$this->current = 0;
return $this->current();
}
public function seek($i): void
{
$this->current = $i;
}
/*** Implement PHP ArrayAccess interface ***/
public function offsetSet($offset, $value): void
{
if (is_null($offset)) {
$offset = count($this->records);
$this->records[] = $value;
}
else {
$this->records[$offset] = $value;
}
}
public function offsetExists($offset): bool
{
return isset($this->records[$offset]);
}
public function offsetUnset($offset): void
{
unset($this->records[$offset]);
}
#[ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->records[$offset];
}
/*** PHP 5 Iterator interface ***/
public function rewind(): void
{
$this->current = 0;
}
#[ReturnTypeWillChange]
public function current()
{
return $this->records[$this->current] ?? null;
}
#[ReturnTypeWillChange]
public function key()
{
return $this->current;
}
#[ReturnTypeWillChange]
public function next()
{
return $this->iterate();
}
public function valid(): bool
{
return isset($this->records[$this->current]);
}
}
|
