Class Horde_Imap_Client_Data_Thread
Object allowing easy access to threaded sort results from
Horde_Imap_Client_Base::thread().
Copyright 2008-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
-
Horde_Imap_Client_Data_Thread
implements
Countable,
Serializable
Methods summary
public
|
#
__construct( array $data, string $type )
Constructor.
Parameters
- $data
- <p>The data as returned by
Horde_Imap_Client_Base::_thread().</p>
- $type
- Either 'uid' or 'sequence'.
|
public
array
|
#
getRawData( )
Return the raw thread data array.
Return the raw thread data array.
Returns
array
See Horde_Imap_Client_Base::_thread().
|
public
mixed
|
#
getThreadIndent( integer $index )
Gets the indention level for an index.
Gets the indention level for an index.
Parameters
Returns
mixedReturns the thread indent level if $index found.
Returns false on failure.
|
public
mixed
|
#
getThreadBase( integer $index )
Gets the base thread index for an index.
Gets the base thread index for an index.
Parameters
Returns
mixedReturns the base index if $index is part of a thread.
Returns false on failure.
|
public
boolean
|
#
lastInLevel( integer $index )
Is this index the last in the current level?
Is this index the last in the current level?
Parameters
Returns
booleanReturns true if $index is the last element in the
current thread level.
Returns false if not, or on failure.
|
public
array
|
#
messageList( )
Return the sorted list of messages indices.
Return the sorted list of messages indices.
Returns
array
The sorted list of messages.
|
public
array
|
#
getThread( integer $index )
Returns the list of messages in the current thread.
Returns the list of messages in the current thread.
Parameters
- $index
- The index of the current message.
Returns
array
A list of message indices.
|
public
|
#
count( )
Implementation of
Countable::count()
|
public
|
#
serialize( )
Implementation of
Serializable::serialize()
|
public
|
#
unserialize( mixed $data )
Implementation of
Serializable::unserialize()
|