Roundcube Framework
\

\rcube_result_multifolder

Class holding a set of rcube_result_index instances that together form a result set of a multi-folder search

Summary

Methods
Properties
Constants
__construct()
add()
set_message_index()
is_error()
is_empty()
count()
count_messages()
revert()
exists()
filter()
slice()
intersect()
get()
get_compressed()
get_element()
get_parameters()
get_set()
__sleep()
__wakeup()
$multi
$sets
$incomplete
$folder
No constants found
append_result()
length()
$meta
$index
$folders
$sdata
$order
$sorting
N/A
No private methods found
No private properties found
N/A

Properties

$multi

$multi

$sets

$sets

$incomplete

$incomplete

$folder

$folder

$meta

$meta

$index

$index

$folders

$folders

$sdata

$sdata

$order

$order

$sorting

$sorting

Methods

__construct()

__construct(array  $folders = []) : mixed

Object constructor.

Parameters

array $folders

List of IMAP folders

Returns

mixed —

add()

add(\rcube_result_index|\rcube_result_thread  $result) : mixed

Initializes object with SORT command response

Parameters

\rcube_result_index|\rcube_result_thread $result

Search result

Returns

mixed —

set_message_index()

set_message_index(\rcube_message_header[]  $headers, string  $sort_field, string  $sort_order) : mixed

Store a global index of (sorted) message UIDs

Parameters

\rcube_message_header[] $headers

Messages in the index
string $sort_field

Header field to sort by
string $sort_order

Sort order

Returns

mixed —

is_error()

is_error() : bool

Checks the result from IMAP command

Returns

bool —

True if the result is an error, False otherwise

is_empty()

is_empty() : bool

Checks if the result is empty

Returns

bool —

True if the result is empty, False otherwise

count()

count() : int

Returns number of elements in the result

Returns

int —

Number of elements

count_messages()

count_messages() : int

Returns number of elements in the result.

Alias for count() for compatibility with rcube_result_thread

Returns

int —

Number of elements

revert()

revert() : mixed

Reverts order of elements in the result

Returns

mixed —

exists()

exists(int  $msgid, bool  $get_index = false) : mixed

Check if the given message ID exists in the object

Parameters

int $msgid

Message ID
bool $get_index

When enabled element's index will be returned. Elements are indexed starting with 0

Returns

mixed —

False if message ID doesn't exist, True if exists or index of the element if $get_index=true

filter()

filter(array  $ids = [], string  $folder = null) : mixed

Filters data set. Removes elements listed in $ids list.

Parameters

array $ids

List of IDs to remove.
string $folder

IMAP folder

Returns

mixed —

slice()

slice(int  $offset, int  $length) : mixed

Slices data set.

Parameters

int $offset

Offset (as for PHP's array_slice())
int $length

Number of elements (as for PHP's array_slice())

Returns

mixed —

intersect()

intersect(array  $ids = []) : mixed

Filters data set. Removes elements not listed in $ids list.

Parameters

array $ids

List of IDs to keep.

Returns

mixed —

get()

get() : array

Return all messages in the result.

Returns

array —

List of message IDs

get_compressed()

get_compressed() : string

Return all messages in the result in compressed form

Returns

string —

List of message IDs in compressed form

get_element()

get_element(int|string  $idx) : int

Return result element at specified index

Parameters

int|string $idx

Element's index or "FIRST" or "LAST"

Returns

int —

Element value

get_parameters()

get_parameters(string  $param = null) : array|string

Returns response parameters, e.g. ESEARCH's MIN/MAX/COUNT/ALL/MODSEQ or internal data e.g. MAILBOX, ORDER

Parameters

string $param

Parameter name

Returns

array|string —

Response parameters or parameter value

get_set()

get_set(string  $folder) : false|\rcube_result_index|\rcube_result_thread

Returns the stored result object for a particular folder

Parameters

string $folder

Folder name

Returns

false|\rcube_result_index|\rcube_result_thread —

A result set or false if none found

__sleep()

__sleep() : array

Serialization __sleep handler

Returns

array —

Names of all object properties that should be serialized

__wakeup()

__wakeup() : mixed

Serialization __wakeup handler

Returns

mixed —

append_result()

append_result(\rcube_result_index|\rcube_result_thread  $result) : mixed

Append message UIDs from the given result to our index

Parameters

\rcube_result_index|\rcube_result_thread $result

Search result

Returns

mixed —

length()

length() : int

Returns length of internal data representation

Returns

int —

Data length