Page MenuHomePhorge
Files F117752117

rcube_result_set.php
No OneTemporary
Actions

Authored By
Unknown
Size
3 KB
Referenced Files
None
Subscribers
None

rcube_result_set.php
View Options

<?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]);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Apr 4, 3:46 AM (1 d, 11 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
3b/e5/9a04df4b5e7b6eba8d5ca17dc9a0
Default Alt Text
rcube_result_set.php (3 KB)

Event Timeline