Class cSearch

CONTENIDO API - Search Object

This object starts a indexed fulltext search.

TODO:

• The way to set the search options could be done much more better!
• The computation of the set of searchable articles should not be

treated in this class.

• It is better to compute the array of searchable articles from the

outside and to pass the array of searchable articles as parameter.

• Avoid foreach loops.

Use object with

$options = array( // use db function regexp 'db' => 'regexp', // combine searchwords with or 'combine' => 'or' );

The range of searchable articles is by default the complete content which is online and not protected.

With option 'searchable_articles' you can define your own set of searchable articles.

If parameter 'searchable_articles' is set, the options 'cat_tree', 'categories', 'articles', 'exclude', 'artspecs', 'protected' and 'dontshowofflinearticles' won't have any effect.

$options = array( // use db function regexp 'db' => 'regexp', // combine searchwords with or 'combine' => 'or', 'searchable_articles' => array(5, 6, 9, 13) );

One can define the range of searchable articles by setting the parameter 'exclude' to false which means the range of categories defined by parameter 'cat_tree' or 'categories' and the range of articles defined by parameter 'articles' is included.

$options = array( // use db function regexp 'db' => 'regexp', // combine searchwords with or 'combine' => 'or', // searchrange specified in 'cat_tree', 'categories' and // 'articles' is included 'exclude' => false, // tree with root 12 included 'cat_tree' => array(12), // categories 100, 111 included 'categories' => array(100,111), // article 33 included 'articles' => array(33), // array of article specifications => search only articles with // these artspecs 'artspecs' => array(2, 3), // results per page 'res_per_page' => 2, // do not search articles or articles in categories which are // offline or protected 'protected' => true, // search offline articles or articles in categories which are // offline 'dontshowofflinearticles' => false );

You can build the complement of the range of searchable articles by setting the parameter 'exclude' to true which means the range of categories defined by parameter 'cat_tree' or 'categories' and the range of articles defined by parameter 'articles' is excluded from search.

$options = array( // use db function regexp 'db' => 'regexp', // combine searchwords with or 'combine' => 'or', // searchrange specified in 'cat_tree', 'categories' and // 'articles' is excluded 'exclude' => true, // tree with root 12 excluded 'cat_tree' => array(12), // categories 100, 111 excluded 'categories' => array(100,111), // article 33 excluded 'articles' => array(33), // array of article specifications => search only articles with // these artspecs 'artspecs' => array(2, 3), // results per page 'res_per_page' => 2, // do not search articles or articles in categories which are // offline or protected 'protected' => true, // search offline articles or articles in categories which are // offline 'dontshowofflinearticles' => false );

$search = new Search($options);

// search only in these cms-types $search->setCmsOptions(array( "htmlhead", "html", "head", "text", "imgdescr", "link", "linkdescr" ));

// start search $search_result = $search->searchIndex($searchword, $searchwordex);

The search result structure has following form Array ( [20] => Array ( [CMS_HTML] => Array ( [0] => 1 [1] => 1 [2] => 1 ) [keyword] => Array ( [0] => content [1] => contenido [2] => wwwcontenidoorg ) [search] => Array ( [0] => con [1] => con [2] => con ) [occurence] => Array ( [0] => 1 [1] => 5 [2] => 1 ) [similarity] => 60 ) )

The keys of the array are the article ID's found by search.

Searching 'con' matches keywords 'content', 'contenido' and 'wwwcontenidoorg' in article with ID 20 in content type CMS_HTML[1]. The search term occurs 7 times. The maximum similarity between searchterm and matching keyword is 60%.

// rank and display the results $oSearchResults = new cSearchResult($search_result, 10);