Detailed Description

IndexedSearch implementations are used to search entity objects in a search index.

Definition at line 22 of file IndexedSearch.php.

Inheritance diagram for IndexedSearch:

Public Member Functions
	resetIndex ()

	addToIndex (PersistentObject $obj)

	deleteFromIndex (PersistentObject $obj)

	commitIndex ($optimize=true)

	optimizeIndex ()

Public Member Functions inherited from Search
	check ($word)

	find ($searchTerm, PagingInfo $pagingInfo=null)

	isSearchable (PersistentObject $obj)

Member Function Documentation

resetIndex ( )

Reset the search index.

Implemented in LuceneSearch.

addToIndex ( PersistentObject $obj )

Add/update a PersistentObject instance to/in the search index.

This method modifies the index. For that reason IndexedSearch::commitIndex() should be called afterwards.

Parameters

$obj	The PersistentObject instance.

Implemented in LuceneSearch.

deleteFromIndex ( PersistentObject $obj )

Delete a PersistentObject instance from the search index.

This method modifies the index. For that reason IndexedSearch::commitIndex() should be called afterwards.

Parameters

$obj	The PersistentObject instance.

Implemented in LuceneSearch.

commitIndex ( $optimize = true )

Commit changes made on the index.

Note: This method only commits the index if changes were made using the methods mentioned above.

Parameters

$optimize Boolean whether the index should be optimized after commit (default: true).

Implemented in LuceneSearch.

optimizeIndex ( )

Optimize the index.

Implemented in LuceneSearch.