Class cSearchIndex

CONTENIDO API - Search Index Object

This object creates an index of an article

Create object with $oIndex = new SearchIndex($db); # where $db is the global CONTENIDO database object. Start indexing with $oIndex->start($idart, $aContent); where $aContent is the complete content of an article specified by its content types. It looks like Array ( [CMS_HTMLHEAD] => Array ( [1] => Herzlich Willkommen... [2] => ...auf Ihrer Website! ) [CMS_HTML] => Array ( [1] => Die Inhalte auf dieser Website ...

The index for keyword 'willkommen' would look like '&12=1(CMS_HTMLHEAD-1)' which means the keyword 'willkommen' occurs 1 times in article with articleId 12 and content type CMS_HTMLHEAD[1].

TODO: The basic idea of the indexing process is to take the complete content of an article and to generate normalized index terms from the content and to store a specific index structure in the relation 'con_keywords'. To take the complete content is not very flexible. It would be better to differentiate by specific content types or by any content. The &, =, () and - seperated string is not easy to parse to compute the search result set. It would be a better idea (and a lot of work) to extend the relation 'con_keywords' to store keywords by articleId (or content source identifier) and content type. The functions removeSpecialChars, setStopwords, setContentTypes and setCmsOptions should be sourced out into a new helper-class. Keep in mind that class Search and SearchResult uses an instance of object Index.

cSearchBaseAbstract

cSearchIndex

Package: Core\Frontend\Search
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Willi Man
Located at classes/search/class.search.index.php

Methods summary
`public`	# `__construct( cDb $db = NULL )` Constructor, set object properties Constructor, set object properties Parameters `$db` `cDb` $db [optional] CONTENIDO database object Overrides `cSearchBaseAbstract::__construct()`
`public`	# `start( integer $idart, array $aContent, string $place = 'auto', array $cms_options = array(), array $aStopwords = array() )` Start indexing the article. Start indexing the article. Parameters `$idart` `integer` $idart Article Id `$aContent` `array` $aContent The complete content of an article specified by its content types. It looks like: Array ( [CMS_HTMLHEAD] => Array ( [1] => Herzlich Willkommen... [2] => ...auf Ihrer Website! ) [CMS_HTML] => Array ( [1] => Die Inhalte auf dieser Website ... ) ) `$place` `string` $place [optional] The field where to store the index information in db. `$cms_options` `array` $cms_options [optional] One can specify explicitly cms types which should not be indexed. `$aStopwords` `array` $aStopwords [optional] Array with words which should not be indexed.
`public`	# `createKeywords( )` For each cms-type create index structure. It looks like: Array ( [die] => CMS_HTML-1 [inhalte] => CMS_HTML-1 [auf] => CMS_HTML-1 CMS_HTMLHEAD-2 [dieser] => CMS_HTML-1 [website] => CMS_HTML-1 CMS_HTML-1 CMS_HTMLHEAD-2 ) For each cms-type create index structure. It looks like: Array ( [die] => CMS_HTML-1 [inhalte] => CMS_HTML-1 [auf] => CMS_HTML-1 CMS_HTMLHEAD-2 [dieser] => CMS_HTML-1 [website] => CMS_HTML-1 CMS_HTML-1 CMS_HTMLHEAD-2 )
`public`	# `saveKeywords( )` Generate index_string from index structure and save keywords. The index_string looks like "&12=2(CMS_HTMLHEAD-1,CMS_HTML-1)". Generate index_string from index structure and save keywords. The index_string looks like "&12=2(CMS_HTMLHEAD-1,CMS_HTML-1)".
`public`	# `deleteKeywords( )` If keywords don't occur in the article anymore, update index_string and delete keyword if necessary. If keywords don't occur in the article anymore, update index_string and delete keyword if necessary.
`public`	# `getKeywords( )` Get the keywords of an article. Get the keywords of an article.
`public mixed`	# `removeSpecialChars( string $key )` Remove special characters from index term. Remove special characters from index term. Parameters `$key` `string` $key Keyword Returns `mixed`
`public string`	# `addSpecialUmlauts( string $key )` Parameters `$key` `string` $key Keyword Returns `string`
`public`	# `setStopwords( array $aStopwords )` set the array of stopwords which should not be indexed set the array of stopwords which should not be indexed Parameters `$aStopwords` `array` $aStopwords
`public`	# `setContentTypes( )` set the cms types set the cms types
`public`	# `setCmsOptions( mixed $cms_options )` set the cms_options array of cms types which should be treated special set the cms_options array of cms types which should be treated special Parameters `$cms_options` `mixed` $cms_options
`public boolean`	# `checkCmsType( string $idtype )` Check if the requested content type should be indexed (false) or not (true) Check if the requested content type should be indexed (false) or not (true) Parameters `$idtype` `string` $idtype Returns `boolean`
`public array`	# `getCmsType( )` Returns `array` the _cmsType property
`public array`	# `getCmsTypeSuffix( )` Returns `array` the _cmsTypeSuffix property

Methods inherited from cSearchBaseAbstract
`_debug()`

Properties summary
`protected array`	`$_keycode`	`array()`	# the content of the cms-types of an article the content of the cms-types of an article
`protected array`	`$_keywords`	`array()`	# the list of keywords of an article the list of keywords of an article
`protected array`	`$_stopwords`	`array()`	# the words, which should not be indexed the words, which should not be indexed
`protected array`	`$_keywordsOld`	`array()`	# the keywords of an article stored in the DB the keywords of an article stored in the DB
`protected array`	`$_keywordsDel`	`array()`	# the keywords to be deleted the keywords to be deleted
`protected string`	`$_place`		# 'auto' or 'self' The field 'auto' in table con_keywords is used for automatic indexing. The value is a string like "&12=2(CMS_HTMLHEAD-1,CMS_HTML-1)", which means a keyword occurs 2 times in article with $idart 12 and can be found in CMS_HTMLHEAD[1] and CMS_HTML[1]. The field 'self' can be used in the article properties to index the article manually. 'auto' or 'self' The field 'auto' in table con_keywords is used for automatic indexing. The value is a string like "&12=2(CMS_HTMLHEAD-1,CMS_HTML-1)", which means a keyword occurs 2 times in article with $idart 12 and can be found in CMS_HTMLHEAD[1] and CMS_HTML[1]. The field 'self' can be used in the article properties to index the article manually.
`protected array`	`$_cmsOptions`	`array()`	# array of cms types array of cms types
`protected array`	`$_cmsType`	`array()`	# array of all available cms types array of all available cms types htmlhead - HTML Headline html - HTML Text head - Headline (no HTML) text - Text (no HTML) img - Upload id of the element imgdescr - Image description link - Link (URL) linktarget - Linktarget (_self, _blank, _top ...) linkdescr - Linkdescription swf - Upload id of the element etc.
`protected array`	`$_cmsTypeSuffix`	`array()`	# the suffix of all available cms types the suffix of all available cms types
`protected integer`	`$idart`		#

Properties inherited from cSearchBaseAbstract
`$cfg, $client, $lang, $oDB`

Packages

Classes

Class cSearchIndex

Parameters

Overrides

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Returns