PHP Класс IMP_Search_Query, horde

Автор: Michael Slusarz ([email protected])
Наследование: implements Serializable
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$enabled boolean Is this query enabled?

Защищенные свойства (Protected)

Свойство Тип Описание
$_cache array Cache results.
$_canEdit boolean Can this query be edited?
$_criteria array The search criteria (IMP_Search_Element objects).
$_id string The search ID.
$_label string The virtual folder label.
$_mboxes array The mailbox list.
$_nosave array List of serialize entries not to save.

Открытые методы

Метод Описание
__construct ( array $opts = [] ) Constructor.
__get ( $name )
__toString ( ) : string String representation of this object: the mailbox ID.
add ( IMP_Search_Element $elt ) Add a search query element.
replace ( array $criteria = [] ) Replace the search query with the given query.
runElementCallbacks ( IMP_Mailbox $mbox, array $ids ) : array Reduce the sorted return ID list by running search element callbacks.
serialize ( ) : string Serialization.
unserialize ( string $data ) Unserialization.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( array $opts = [] )
$opts array

__get() публичный Метод

public __get ( $name )

__toString() публичный Метод

String representation of this object: the mailbox ID.
public __toString ( ) : string
Результат string Mailbox ID.

add() публичный Метод

Add a search query element.
public add ( IMP_Search_Element $elt )
$elt IMP_Search_Element The search element to add.

replace() публичный Метод

Replace the search query with the given query.
public replace ( array $criteria = [] )
$criteria array A list of criteria to add (Horde_Search_Element objects).

runElementCallbacks() публичный Метод

.
public runElementCallbacks ( IMP_Mailbox $mbox, array $ids ) : array
$mbox IMP_Mailbox Mailbox.
$ids array Sorted ID list.
Результат array Sorted ID list.

serialize() публичный Метод

Serialization.
public serialize ( ) : string
Результат string Serialized data.

unserialize() публичный Метод

Unserialization.
public unserialize ( string $data )
$data string Serialized data.

Описание свойств

$_cache защищенное свойство

Cache results.
protected array $_cache
Результат array

$_canEdit защищенное свойство

Can this query be edited?
protected bool $_canEdit
Результат boolean

$_criteria защищенное свойство

The search criteria (IMP_Search_Element objects).
protected array $_criteria
Результат array

$_id защищенное свойство

The search ID.
protected string $_id
Результат string

$_label защищенное свойство

The virtual folder label.
protected string $_label
Результат string

$_mboxes защищенное свойство

The mailbox list.
protected array $_mboxes
Результат array

$_nosave защищенное свойство

List of serialize entries not to save.
protected array $_nosave
Результат array

$enabled публичное свойство

Is this query enabled?
public bool $enabled
Результат boolean