PHP Class Horde_Imap_Client_Ids_Map, horde

Since: 2.1.0
Author: Michael Slusarz ([email protected])
Inheritance: implements Countable, implements IteratorAggregate, implements Serializable
Exibir arquivo Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_ids array Sequence -> UID mapping.
$_sorted boolean Is the array sorted?

Public Methods

Method Description
__construct ( array $ids = [] ) Constructor.
__get ( $name )
count ( )
getIterator ( )
lookup ( Horde_Imap_Client_Ids $ids ) : array Create a Sequence <-> UID lookup table.
remove ( Horde_Imap_Client_Ids $ids ) Removes messages from the ID mapping.
serialize ( )
sort ( ) Sort the map.
unserialize ( $data )
update ( array $ids ) : boolean Updates the mapping.

Method Details

__construct() public method

Constructor.
public __construct ( array $ids = [] )
$ids array Array of sequence -> UID mapping.

__get() public method

public __get ( $name )

count() public method

public count ( )

getIterator() public method

public getIterator ( )

lookup() public method

Create a Sequence <-> UID lookup table.
public lookup ( Horde_Imap_Client_Ids $ids ) : array
$ids Horde_Imap_Client_Ids IDs to lookup.
return array Keys are sequence numbers, values are UIDs.

remove() public method

Removes messages from the ID mapping.
public remove ( Horde_Imap_Client_Ids $ids )
$ids Horde_Imap_Client_Ids IDs to remove.

serialize() public method

public serialize ( )

sort() public method

Sort the map.
public sort ( )

unserialize() public method

public unserialize ( $data )

update() public method

Updates the mapping.
public update ( array $ids ) : boolean
$ids array Array of sequence -> UID mapping.
return boolean True if the mapping changed.

Property Details

$_ids protected_oe property

Sequence -> UID mapping.
protected array $_ids
return array

$_sorted protected_oe property

Is the array sorted?
protected bool $_sorted
return boolean