Documentation

Horde_Imap_Client_Fetch_Results
in package
implements ArrayAccess, Countable, IteratorAggregate

Fetch results object for use with Horde_Imap_Client_Base#fetch().

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Interfaces, Classes, Traits and Enums

ArrayAccess
Countable
IteratorAggregate

Table of Contents

SEQUENCE  = 1
Key type constants.
UID  = 2
$key_type  : int
$_data  : array<string|int, mixed>
Internal data array.
$_keyType  : int
Key type.
$_obClass  : string
Class to use when creating a new fetch object.
__construct()  : mixed
Constructor.
__get()  : mixed
clear()  : mixed
Clears all fetch results.
count()  : mixed
first()  : null|Horde_Imap_Client_Data_Fetch
Return the first fetch object in the results, if there is only one object.
get()  : Horde_Imap_Client_Data_Fetch
Return a fetch object, creating and storing an empty object in the results set if it doesn't currently exist.
getIterator()  : mixed
ids()  : array<string|int, mixed>
Return the list of IDs.
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed

Constants

SEQUENCE

Key type constants.

public mixed SEQUENCE = 1

Properties

$key_type read-only

public int $key_type

The key type (sequence or UID).

$_data

Internal data array.

protected array<string|int, mixed> $_data = array()

$_keyType

Key type.

protected int $_keyType

$_obClass

Class to use when creating a new fetch object.

protected string $_obClass

Methods

__construct()

Constructor.

public __construct([string $ob_class = 'Horde_Imap_Client_Data_Fetch' ][, int $key_type = self::UID ]) : mixed
Parameters
$ob_class : string = 'Horde_Imap_Client_Data_Fetch'

Class to use when creating a new fetch object.

$key_type : int = self::UID

Key type.

Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

clear()

Clears all fetch results.

public clear() : mixed
Tags
since
2.6.0
Return values
mixed

count()

public count() : mixed
Return values
mixed

getIterator()

public getIterator() : mixed
Return values
mixed

ids()

Return the list of IDs.

public ids() : array<string|int, mixed>
Return values
array<string|int, mixed>

ID list.

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

Search results