Horde_Imap_Client_Data_Thread
in package
implements
Countable, Serializable
Object representing the threaded sort results from Horde_Imap_Client_Base#thread().
Tags
Interfaces, Classes, Traits and Enums
- Countable
- Serializable
Table of Contents
- $_thread : array<string|int, mixed>
- 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.
- __construct() : mixed
- Constructor.
- __serialize() : array<string|int, mixed>
- __unserialize() : mixed
- count() : mixed
- getThread() : array<string|int, mixed>
- Returns the list of messages in a thread.
- getThreads() : array<string|int, mixed>
- Returns array of all threads.
- getType() : string
- Return the ID type.
- messageList() : Horde_Imap_Client_Ids
- Return the sorted list of messages indices.
- serialize() : mixed
- unserialize() : mixed
- _getAllIndices() : array<string|int, mixed>
- Return all indices.
Properties
$_thread
Internal thread data structure. Keys are base values, values are arrays with keys as the ID and values as the level.
protected
array<string|int, mixed>
$_thread
= array()
$_type
The index type.
protected
string
$_type
Methods
__construct()
Constructor.
public
__construct(array<string|int, mixed> $data, string $type) : mixed
Parameters
- $data : array<string|int, mixed>
-
See $_thread.
- $type : string
-
Either 'sequence' or 'uid'.
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —count()
public
count() : mixed
Return values
mixed —getThread()
Returns the list of messages in a thread.
public
getThread(int $index) : array<string|int, mixed>
Parameters
- $index : int
-
An index contained in the thread.
Return values
array<string|int, mixed> —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.
getThreads()
Returns array of all threads.
public
getThreads() : array<string|int, mixed>
Return values
array<string|int, mixed> —Keys of thread arrays 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()
Return the ID type.
public
getType() : string
Return values
string —Either 'sequence' or 'uid'.
messageList()
Return the sorted list of messages indices.
public
messageList() : Horde_Imap_Client_Ids
Return values
Horde_Imap_Client_Ids —The sorted list of messages.
serialize()
public
serialize() : mixed
Return values
mixed —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —_getAllIndices()
Return all indices.
protected
_getAllIndices() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of indices.