Class IMP_Search

The IMP_Search:: class contains all code related to mailbox searching in IMP.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

IMP_Search implements ArrayAccess, Iterator, Serializable

Package: IMP
Category: Horde
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Search.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor.
`public`	# `init( )` Initialize session search data. Initialize session search data.
`public IMP_Indices`	# `runSearch( object $ob, string $id )` Run a search. Run a search. Parameters `$ob` <p>An optional search query to add (via 'AND') to the active search (Horde_Imap_Client_Search_Query).</p> `$id` The search query id. Returns `IMP_Indices` An indices object. Throws `IMP_Imap_Exception`
`public IMP_Search_Query`	# `createQuery( array $criteria, array $opts = array() )` Creates the IMAP search query in the IMP session. Creates the IMAP search query in the IMP session. Parameters `$criteria` The search criteria array. `$opts` <p>Additional options: - id: (string) Use as the mailbox ID. - label: (string) The label to use for the search results. - mboxes: (array) The list of mailboxes to directly search. If this contains the IMP_Search_Query::ALLSEARCH constant, all mailboxes will be searched. - subfolders: (array) The list of mailboxes to do subfolder searches on. - type: (integer) Query type.</p> Returns `IMP_Search_Query` Returns the query object. Throws InvalidArgumentException
`public`	# `setFilters( array $filters )` Saves the list of filters for the current user. Saves the list of filters for the current user. Parameters `$filters` The filter list.
`public`	# `isFilter( string $id, boolean $editable = false )` Is a mailbox a filter query? Is a mailbox a filter query? Parameters `$id` The mailbox ID. `$editable` <p>Is this an editable (i.e. not built-in) filter query?</p>
`public IMP_Search_Query`	# `applyFilter( string $id, array $mboxes, string $mid = null )` Converts a filter to a search query and stores it in the local session. Converts a filter to a search query and stores it in the local session. Parameters `$id` The mailbox ID of the filter. `$mboxes` The list of mailboxes to apply the filter on. `$mid` Use as the mailbox ID. Returns `IMP_Search_Query` The created query object. Throws InvalidArgumentException
`public`	# `setVFolders( array $vfolders )` Saves the list of virtual folders for the current user. Saves the list of virtual folders for the current user. Parameters `$vfolders` The virtual folder list.
`public boolean`	# `isVFolder( string $id, boolean $editable = false )` Is a mailbox a virtual folder? Is a mailbox a virtual folder? Parameters `$id` The mailbox ID. `$editable` <p>Is this an editable (i.e. not built-in) virtual folder?</p> Returns `boolean` Whether the mailbox ID is a virtual folder.
`public boolean`	# `isVTrash( string $id )` Determines whether a mailbox ID is the Virtual Trash Folder. Determines whether a mailbox ID is the Virtual Trash Folder. Parameters `$id` The mailbox id. Returns `boolean` True if the ID is the Virtual Trash folder.
`public boolean`	# `isVinbox( string $id )` Determines whether a mailbox ID is the Virtual INBOX Folder. Determines whether a mailbox ID is the Virtual INBOX Folder. Parameters `$id` The mailbox id. Returns `boolean` True if the ID is the Virtual INBOX folder.
`public`	# `isQuery( string $id, boolean $editable = false )` Is a mailbox a search query? Is a mailbox a search query? Parameters `$id` The mailbox ID. `$editable` <p>Is this an editable (i.e. not built-in) search query?</p>
`public Horde_Url`	# `editUrl( string $id )` Returns a link to edit a given search query. Returns a link to edit a given search query. Parameters `$id` The search query id. Returns `Horde_Url` The URL to the search page.
`public boolean`	# `isSearchMbox( string $id )` Is the given mailbox a search mailbox? Is the given mailbox a search mailbox? Parameters `$id` The mailbox name. Returns `boolean` Whether the given mailbox name is a search mailbox.
`public string`	# `createSearchId( string $id )` Create the canonical search ID for a given search query. Create the canonical search ID for a given search query. Parameters `$id` The mailbox query ID. Returns `string` The canonical search query ID.
`public`	# `offsetExists( mixed $offset )` Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetGet( mixed $offset )` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( string $offset, IMP_Search_Query $value )` Alter the current IMAP search query. Alter the current IMAP search query. Parameters `$offset` $id The search query id. `$value` The query object. Throws InvalidArgumentException Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( string $offset )` Deletes an IMAP search query. Deletes an IMAP search query. Parameters `$offset` $id The search query id. Implementation of `ArrayAccess::offsetUnset()`
`public`	# `current( )` Implementation of `Iterator::current()`
`public`	# `key( )` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public`	# `setIteratorFilter( integer $mask = 0 )` Set the current iterator filter and reset the internal pointer. Set the current iterator filter and reset the internal pointer. Parameters `$mask` A mask with the following possible elements: <pre>IMP_Search::LIST_FILTER IMP_Search::LIST_QUERY IMP_Search::LIST_VFOLDER</pre>
`public string`	# `serialize( )` Serialize. Serialize. Returns `string` Serialized representation of this object. Implementation of `Serializable::serialize()`
`public`	# `unserialize( string $data )` Unserialize. Unserialize. Parameters `$data` Serialized data. Throws Exception Implementation of `Serializable::unserialize()`

Constants summary
`string`	`MBOX_PREFIX`	# `"impsearch\0"`
`string`	`BASIC_SEARCH`	# `'impbsearch'`
`string`	`DIMP_FILTERSEARCH`	# `'dimpfsearch'`
`string`	`DIMP_QUICKSEARCH`	# `'dimpqsearch'`
`integer`	`LIST_FILTER`	# `1`
`integer`	`LIST_QUERY`	# `2`
`integer`	`LIST_VFOLDER`	# `4`
`integer`	`LIST_DISABLED`	# `8`
`integer`	`CREATE_FILTER`	# `1`
`integer`	`CREATE_QUERY`	# `2`
`integer`	`CREATE_VFOLDER`	# `3`

Properties summary
`public boolean`	`$changed` Has the object data changed? Has the object data changed?	# `false`

Packages

Classes

Class IMP_Search

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Parameters

Parameters

Returns

Throws

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Implementation of

Parameters

Throws

Implementation of

Parameters

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Parameters

Returns

Implementation of

Parameters

Throws

Implementation of