PHP Class Horde_Imap_Client_Fetch_Results, horde

Author: Michael Slusarz ([email protected])

Inheritance: implements ArrayAccess, implements Countable, implements IteratorAggregate

Protected Properties

Property	Type	Description
$_data	array	Internal data array.
$_keyType	integer	Key type.
$_obClass	string	Class to use when creating a new fetch object.

Method	Description
__construct ( string $ob_class = 'Horde_Imap_Client_Data_Fetch', integer $key_type = self::UID )	Constructor.
__get ( $name )
clear ( )	Clears all fetch results.
count ( )
first ( ) : null \| Horde_Imap_Client_Data_Fetch	Return the first fetch object in the results, if there is only one object.
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.
getIterator ( )
ids ( ) : array	Return the list of IDs.
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )

Constructor.

public __construct ( string $ob_class = 'Horde_Imap_Client_Data_Fetch', integer $key_type = self::UID )
$ob_class	string	Class to use when creating a new fetch object.
$key_type	integer	Key type.

public __get ( $name )

Clears all fetch results.

Since: 2.6.0

public clear ( )

public count ( )

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

public first ( ) : null \| Horde_Imap_Client_Data_Fetch
return	null \| Horde_Imap_Client_Data_Fetch	The fetch object if there is only one object, or null.

Return a fetch object, creating and storing an empty object in the results set if it doesn't currently exist.

public get ( string $key ) : Horde_Imap_Client_Data_Fetch
$key	string	The key to retrieve.
return	Horde_Imap_Client_Data_Fetch	The fetch object.

public getIterator ( )

Return the list of IDs.

public ids ( ) : array
return	array	ID list.

public offsetExists ( $offset )

public offsetGet ( $offset )

public offsetSet ( $offset, $value )

public offsetUnset ( $offset )

Internal data array.

protected array $_data
return	array

Key type.

protected int $_keyType
return	integer

Class to use when creating a new fetch object.

protected string $_obClass
return	string