Class IMP_Search_Query

Data structure for a search query.

IMP_Search_Query implements Serializable

Direct known subclasses

IMP_Search_Filter, IMP_Search_Vfolder

Indirect known subclasses

IMP_Search_Filter_Attachment, IMP_Search_Filter_Autogenerated, IMP_Search_Filter_Builtin, IMP_Search_Filter_Bulk, IMP_Search_Filter_Contacts, IMP_Search_Filter_Mailinglist, IMP_Search_Filter_Personal, IMP_Search_Vfolder_Builtin, IMP_Search_Vfolder_Vinbox, IMP_Search_Vfolder_Vtrash

Package: IMP
Category: Horde
Copyright: 2010-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Search/Query.php

Methods summary
`public`	# `__construct( array $opts = array() )` Constructor. Constructor. Var array $opts Options: - add: (array) A list of criteria to add (Horde_Search_Element objects). DEFAULT: No criteria explicitly added. - all: (boolean) Search all mailboxes? If set, ignores 'mboxes' and 'subfolders' options. DEFAULT: false - disable: (boolean) Disable this query? DEFAULT: false - id: (string) Use this ID. DEFAULT: ID automatically generated. - label: (string) The label for this query. DEFAULT: Search Results - mboxes: (array) The list of mailboxes to search. DEFAULT: None - subfolders: (array) The list of mailboxes to do subfolder searches for. DEFAULT: None
`public`	# `__get( mixed $name )`
`public string`	# `__toString( )` String representation of this object: the mailbox ID. String representation of this object: the mailbox ID. Returns `string` Mailbox ID.
`public`	# `add( IMP_Search_Element $elt )` Add a search query element. Add a search query element. Parameters `$elt` The search element to add.
`public`	# `replace( array $criteria = array() )` Replace the search query with the given query. Replace the search query with the given query. Parameters `$criteria` <p>A list of criteria to add (Horde_Search_Element objects).</p>
`public string`	# `serialize( )` Serialization. Serialization. Returns `string` Serialized data. Implementation of `Serializable::serialize()`
`public`	# `unserialize( string $data )` Unserialization. Unserialization. Parameters `$data` Serialized data. Throws Exception Implementation of `Serializable::unserialize()`

Constants summary
`integer`	`VERSION`	# `1`
`string`	`SUBFOLDER`	# `"sub\0"`
`string`	`ALLSEARCH`	# `"all\0"`

Properties summary
`public boolean`	`$enabled` Is this query enabled? Is this query enabled?	# `true`

Magic properties summary
`public boolean`	`$all` Does this query search all mailboxes?
`public boolean`	`$canEdit` Can this query be edited?
`public string`	`$formid` The mailbox ID to use in forms.
`public string`	`$id` The query ID.
`public string`	`$label` The query label.
`public array`	`$mboxes` The list of mailboxes to query. This list automatically expands subfolder searches.
`public array`	`$mbox_list` The list of individual mailboxes to query (no subfolder mailboxes).
`public IMP_Mailbox`	`$mbox_ob` The IMP_Mailbox object for this query.
`public string`	`$mid` The query ID with the search mailbox prefix.
`public array`	`$query` The list of IMAP queries that comprise this search. Keys are mailbox names, values are Horde_Imap_Client_Search_Query objects.
`public string`	`$querytext` The textual representation of the query.
`public array`	`$subfolder_list` The list of mailboxes to do subfolder queries for. The subfolders are not expanded.