PHP Class Horde_Imap_Client_Data_Thread, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements Countable, implements Serializable
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_thread array Internal thread data structure. Keys are base values, values are arrays with keys as the ID and values as the level.
$_type string The index type.

Public Methods

Method Description
__construct ( array $data, string $type ) Constructor.
count ( )
getThread ( integer $index ) : array Returns the list of messages in a thread.
getType ( ) : string Return the ID type.
messageList ( ) : Horde_Imap_Client_Ids Return the sorted list of messages indices.
serialize ( )
unserialize ( $data )

Protected Methods

Method Description
_getAllIndices ( ) : array Return all indices.

Method Details

__construct() public method

Constructor.
public __construct ( array $data, string $type )
$data array See $_thread.
$type string Either 'sequence' or 'uid'.

_getAllIndices() protected method

Return all indices.
protected _getAllIndices ( ) : array
return array An array of indices.

count() public method

public count ( )

getThread() public method

Returns the list of messages in a thread.
public getThread ( integer $index ) : array
$index integer An index contained in the thread.
return array Keys are indices, values are objects with the following properties: - base: (integer) Base ID of the thread. If null, thread is a single message. - last: (boolean) If true, this is the last index in the sublevel. - level: (integer) The sublevel of the index.

getType() public method

Return the ID type.
public getType ( ) : string
return string Either 'sequence' or 'uid'.

messageList() public method

Return the sorted list of messages indices.
public messageList ( ) : Horde_Imap_Client_Ids
return Horde_Imap_Client_Ids The sorted list of messages.

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )

Property Details

$_thread protected property

Internal thread data structure. Keys are base values, values are arrays with keys as the ID and values as the level.
protected array $_thread
return array

$_type protected property

The index type.
protected string $_type
return string