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('db' => 'regexp', // use db function regexp 'combine' => 'or'); // combine searchwords with 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', 'dontshowofflinearticles' don't have any effect.

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

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

$search = new Search($options);

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

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

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%.

with $oSearchResults = new SearchResult($search_result, 10); one can rank and display the results

version 1.0.1
author Willi Man
copyright four for business AG

 Methods

Add all article specifications matching name of article specification (client dependent but language independent)

addArticleSpecificationsByName($sArtSpecName) : void

Parameters

$sArtSpecName

Fetch all article specifications which are online

getArticleSpecifications() : Array

Returns

Arrayof article specification Ids

getSearchableArticles()

getSearchableArticles($search_range) : \Articles

Parameters

$search_range

Returns

\Articlesin specified search range

getSubTree()

getSubTree($cat_start) : \Category

Parameters

$cat_start

Root of a category tree

Returns

\CategoryTree

indexed fulltext search

searchIndex(string $searchwords, string $searchwords_exclude) : void

Parameters

$searchwords

string

The search words

$searchwords_exclude

string

The words, which should be excluded from search

Set article specification

setArticleSpecification($iArtspecID) : void

Parameters

$iArtspecID

setCmsOptions()

setCmsOptions($cms_options) : void

Parameters

$cms_options

The cms-types (htmlhead, html, ...) which should explicitly be searched

stripWords()

stripWords($searchwords) : Array

Parameters

$searchwords

The search-words

Returns

Arrayof stripped search-words

 Properties

 

$article_specs : array
 

$bDebug : boolean
 

$cfg : array
 

$client : int
 

$cms_type : array
 

$cms_type_suffix : array
 

$db : object
 

$dontshowofflinearticles : boolean
 

$exclude : boolean
 

$index : object
 

$lang : int
 

$protected : boolean
 

$search_combination : string
 

$search_option : string
 

$search_result : array

..

 

$search_words : array
 

$search_words_exclude : array
 

$searchable_arts : array