Class FinderIndexerToken

Description

Token class for the Finder indexer package.

  • since: 2.5

Located in /administrator/components/com_finder/helpers/indexer/token.php (line 19)


	
			
Variable Summary
 boolean $common
 string $language
 integer $length
 boolean $numeric
 boolean $phrase
 string $stem
 string $term
 integer $weight
Method Summary
 FinderIndexerToken __construct (mixed $term, string $lang, [string $spacer = ' '])
Variables
boolean $common (line 55)

If the token is a common term, the weight is adjusted to compensate for the higher frequency of the term in relation to other terms.

  • since: 2.5
  • access: public
string $language (line 88)

The simple language identifier for the token.

  • since: 2.5
  • access: public
integer $length (line 71)

The length is used to calculate the weight of the token.

  • since: 2.5
  • access: public
boolean $numeric (line 46)

If the token is numeric, it is likely to be short and uncommon so the weight is adjusted to compensate for that situation.

  • since: 2.5
  • access: public
boolean $phrase (line 63)

Flag for phrase tokens.

  • since: 2.5
  • access: public
string $stem (line 37)

The stem is used to match the root term and produce more potential matches when searching the index.

  • since: 2.5
  • access: public
string $term (line 28)

This is the term that will be referenced in the terms table and the mapping tables.

  • since: 2.5
  • access: public
integer $weight (line 80)

The weight is calculated based on token size and whether the token is considered a common term.

  • since: 2.5
  • access: public
Methods
Constructor __construct (line 99)

Method to construct the token object.

  • since: 2.5
  • access: public
FinderIndexerToken __construct (mixed $term, string $lang, [string $spacer = ' '])
  • mixed $term: The term as a string for words or an array for phrases.
  • string $lang: The simple language identifier.
  • string $spacer: The space separator for phrases. [optional]

Documentation generated on Tue, 19 Nov 2013 15:15:48 +0100 by phpDocumentor 1.4.3