ISearchIndex Interface Reference

Interface for a search index. More...

Inheritance diagram for ISearchIndex:

List of all members.

Public Member Functions
	exclude_models ($models)
	Exclude models from search.
	limit_to_models ($models)
	Include only given models in search.
	set_matching ($matching)
	Set matching mode (MATCH_WIDE or MATCH_NARROW).
	set_search ($search)
	Set the search string.
	sort_by_relevance ()
	Sort by Relevance.
Public Attributes
const	MATCH_NARROW = 'narrow'
	Set to narrow result (default).
const	MATCH_WIDE = 'wide'
	Set to retrieve widest possible result.

---

Detailed Description

Interface for a search index.

Author:

Gerd Riesselmann

Definition at line 8 of file isearchindex.cls.php.

---

Member Function Documentation

ISearchIndex::exclude_models

(

$

models

)

Exclude models from search.

Parameters:

string|array

Name of model or array of names of models

Implemented in DataObjectSearchIndexSphinxBase.

ISearchIndex::limit_to_models

(

$

models

)

Include only given models in search.

Parameters:

string|array

Name of model or array of names of models

Implemented in DataObjectSearchIndexSphinxBase.

ISearchIndex::set_matching

(

$

matching

)

Set matching mode (MATCH_WIDE or MATCH_NARROW).

Implemented in DataObjectSearchIndexSphinxBase.

ISearchIndex::set_search

(

$

search

)

Set the search string.

Parameters:

string

$search The search string

Implemented in DataObjectSearchIndexSphinxBase.

ISearchIndex::sort_by_relevance

(

)

Sort by Relevance.

Implemented in DataObjectSearchIndexSphinxBase.

---

Member Data Documentation

const ISearchIndex::MATCH_NARROW = 'narrow'

Set to narrow result (default).

Definition at line 16 of file isearchindex.cls.php.

const ISearchIndex::MATCH_WIDE = 'wide'

Set to retrieve widest possible result.

Definition at line 12 of file isearchindex.cls.php.

---

The documentation for this interface was generated from the following file:

• contributions/models.searchindex/lib/interfaces/isearchindex.cls.php