PHP Class IMP_Search_Element, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements Serializable
Show file Open project: horde/horde

Public Properties

Property Type Description
$not boolean Allow NOT search on this element?

Protected Properties

Property Type Description
$_data object Data for this element.

Public Methods

Method Description
createQuery ( string $mbox, Horde_Imap_Client_Search_Query $queryob ) : Horde_Imap_Client_Search_Query Adds the current query item to the query object.
getCriteria ( ) : object Returns the criteria data for the element.
queryText ( ) : array Return search query text representation.
serialize ( ) : string Serialization.
unserialize ( string $data ) Unserialization.

Method Details

createQuery() abstract public method

Adds the current query item to the query object.
abstract public createQuery ( string $mbox, Horde_Imap_Client_Search_Query $queryob ) : Horde_Imap_Client_Search_Query
$mbox string The mailbox to create the query for.
$queryob Horde_Imap_Client_Search_Query The query object.
return Horde_Imap_Client_Search_Query The altered query object.

getCriteria() public method

Returns the criteria data for the element.
public getCriteria ( ) : object
return object The criteria (see each class for the available properties).

queryText() abstract public method

Return search query text representation.
abstract public queryText ( ) : array
return array The textual description of this search element.

serialize() public method

Serialization.
public serialize ( ) : string
return string Serialized data.

unserialize() public method

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

Property Details

$_data protected property

Data for this element.
protected object $_data
return object

$not public property

Allow NOT search on this element?
public bool $not
return boolean