Documentation

Horde_Imap_Client_Ids_Map
in package
implements Countable, IteratorAggregate, Serializable

An object implementing lookups between UIDs and message sequence numbers.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.1.0

Interfaces, Classes, Traits and Enums

Countable
IteratorAggregate
Serializable

Table of Contents

$map  : array<string|int, mixed>
$seq  : Horde_Imap_Client_Ids
$uids  : Horde_Imap_Client_Ids
$_ids  : array<string|int, mixed>
Sequence -> UID mapping.
$_sorted  : bool
Is the array sorted?
__construct()  : mixed
Constructor.
__get()  : mixed
__serialize()  : array<string|int, mixed>
__unserialize()  : mixed
count()  : mixed
getIterator()  : mixed
lookup()  : array<string|int, mixed>
Create a Sequence <-> UID lookup table.
remove()  : mixed
Removes messages from the ID mapping.
serialize()  : mixed
sort()  : mixed
Sort the map.
unserialize()  : mixed
update()  : bool
Updates the mapping.

Properties

$map read-only

public array<string|int, mixed> $map

The raw ID mapping data.

$_ids

Sequence -> UID mapping.

protected array<string|int, mixed> $_ids = array()

$_sorted

Is the array sorted?

protected bool $_sorted = \true

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $ids = array() ]) : mixed
Parameters
$ids : array<string|int, mixed> = array()

Array of sequence -> UID mapping.

Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
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

getIterator()

public getIterator() : mixed
Return values
mixed

lookup()

Create a Sequence <-> UID lookup table.

public lookup(Horde_Imap_Client_Ids $ids) : array<string|int, mixed>
Parameters
$ids : Horde_Imap_Client_Ids

IDs to lookup.

Return values
array<string|int, mixed>

Keys are sequence numbers, values are UIDs.

serialize()

public serialize() : mixed
Return values
mixed

sort()

Sort the map.

public sort() : mixed
Return values
mixed

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

update()

Updates the mapping.

public update(array<string|int, mixed> $ids) : bool
Parameters
$ids : array<string|int, mixed>

Array of sequence -> UID mapping.

Return values
bool

True if the mapping changed.

Search results