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

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * Interface for a search index
00004  * 
00005  * @ingroup SearchIndex
00006  * @author Gerd Riesselmann
00007  */
00008 interface ISearchIndex extends ISearchAdapter {
00009         /**
00010          * Set to retrieve widest possible result
00011          */
00012         const MATCH_WIDE = 'wide';
00013         /**
00014          * Set to narrow result (default)
00015          */
00016         const MATCH_NARROW = 'narrow';
00017         
00018         /**
00019          * Set the search string
00020          * 
00021          * @param string $search The search string
00022          */
00023         public function set_search($search);
00024         
00025         /**
00026          * Exclude models from search
00027          * 
00028          * @param string|array Name of model or array of names of models
00029          */
00030         public function exclude_models($models);
00031         
00032         /**
00033          * Include only given models in search
00034          * 
00035          * @param string|array Name of model or array of names of models
00036          */
00037         public function limit_to_models($models);
00038         
00039         /**
00040          * Sort by Relevance 
00041          */
00042         public function sort_by_relevance();
00043         
00044         /**
00045          * Set matching mode (MATCH_WIDE or MATCH_NARROW) 
00046          */
00047         public function set_matching($matching);
00048 }