API Documentation
\

\Horde_Imap_Client_Fetch_Results

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

Summary

Methods
Properties
Constants
__construct()
__get()
get()
ids()
first()
clear()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
count()
getIterator()
$key_type
SEQUENCE
UID
No protected methods found
$_data
$_keyType
$_obClass
N/A
No private methods found
No private properties found
N/A

Constants

SEQUENCE

SEQUENCE

Key type constants.

UID

UID

Properties

$key_type

$key_type : integer

The key type (sequence or UID).

Type

integer

$_data

$_data : array

Internal data array.

Type

array

$_keyType

$_keyType : integer

Key type.

Type

integer

$_obClass

$_obClass : string

Class to use when creating a new fetch object.

Type

string

Methods

__construct()

__construct(string  $ob_class = 'Horde_Imap_Client_Data_Fetch', integer  $key_type = self::UID)

Constructor.

Parameters

string $ob_class

Class to use when creating a new fetch object.
integer $key_type

Key type.

__get()

__get(  $name)

Parameters

$name

get()

get(string  $key) : \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.

Parameters

string $key

The key to retrieve.

Returns

\Horde_Imap_Client_Data_Fetch —

The fetch object.

ids()

ids() : array

Return the list of IDs.

Returns

array —

ID list.

first()

first() : null|\Horde_Imap_Client_Data_Fetch

Return the first fetch object in the results, if there is only one object.

Returns

null|\Horde_Imap_Client_Data_Fetch —

The fetch object if there is only one object, or null.

clear()

clear()

Clears all fetch results.

offsetExists()

offsetExists(  $offset)

Parameters

$offset

offsetGet()

offsetGet(  $offset)

Parameters

$offset

offsetSet()

offsetSet(  $offset,   $value)

Parameters

$offset
$value

offsetUnset()

offsetUnset(  $offset)

Parameters

$offset

count()

count()

getIterator()

getIterator()