Référence de la classe FinderIndexerHelper

Fonctions membres publiques statiques
static	parse ($input, $format='html')
static	tokenize ($input, $lang, $phrase=false)
static	stem ($token, $lang)
static	addContentType ($title, $mime=null)
static	isCommon ($token, $lang)
static	getCommonWords ($lang)
static	getDefaultLanguage ()
static	getPrimaryLanguage ($lang)
static	getContentPath ($url)
static	getContentExtras (FinderIndexerResult $item)
static	prepareContent ($text, $params=null, FinderIndexerResult $item=null)

Attributs publics statiques
static	$stemmer

Attributs protégés statiques
static	$stemmerOK

Description détaillée

Helper class for the Finder indexer package.

Depuis

2.5

Documentation des fonctions membres

addContentType()

static addContentType (   $title,   $mime = null  )

static

Method to add a content type to the database.

Paramètres

string	$title	The type of content. For example: PDF
string	$mime	The mime type of the content. For example: PDF [optional]

Renvoie

integer The id of the content type.

Depuis

2.5

Exceptions

Exception

on database error.

Références $db, $mime, $query, et $title.

Référencé par FinderIndexerAdapter\__construct().

getCommonWords()

static getCommonWords (   $lang )

static

Method to get an array of common terms for a language.

Paramètres

string

$lang

The language to use.

Renvoie

array Array of common terms.

Depuis

2.5

Exceptions

Exception

on database error.

Références $db, $lang, et $query.

getContentExtras()

static getContentExtras ( FinderIndexerResult  $item )

static

Method to get extra data for a content before being indexed. This is how we add Comments, Tags, Labels, etc. that should be available to Finder.

Paramètres

FinderIndexerResult

$item

The item to index as a FinderIndexerResult object.

Renvoie

boolean True on success, false on failure.

Depuis

2.5

Exceptions

Exception

on database error.

Références $dispatcher, $item, $results, et JEventDispatcher\getInstance().

Référencé par PlgFinderTags\index(), PlgFinderCategories\index(), PlgFinderContent\index(), PlgFinderNewsfeeds\index(), et PlgFinderContacts\index().

getContentPath()

static getContentPath (   $url )

static

Method to get the path (SEF route) for a content item.

Paramètres

string

$url

The non-SEF route to the content item.

Renvoie

string The path for the content item.

Depuis

2.5

Obsolète:

4.0

Références $config, $route, $uri, et $url.

Référencé par PlgFinderTags\index(), PlgFinderContent\index(), PlgFinderCategories\index(), PlgFinderContacts\index(), PlgFinderNewsfeeds\index(), et PlgFinderContacts\setup().

getDefaultLanguage()

static getDefaultLanguage ( )

static

Method to get the default language for the site.

Renvoie

string The default language string.

Depuis

2.5

Références $lang.

Référencé par FinderIndexerQuery\__construct(), et FinderModelSuggestions\populateState().

getPrimaryLanguage()

static getPrimaryLanguage (   $lang )

static

Method to parse a language/locale key and return a simple language string.

Paramètres

string

$lang

The language/locale key. For example: en-GB

Renvoie

string The simple language string. For example: en

Depuis

2.5

Références $data, et $lang.

Référencé par FinderIndexerQuery\__construct(), et FinderModelSuggestions\populateState().

isCommon()

static isCommon (   $token,   $lang  )

static

Method to check if a token is common in a language.

Paramètres

string	$token	The token to test.
string	$lang	The language to reference.

Renvoie

boolean True if common, false otherwise.

Depuis

2.5

Références $data, $default, $lang, et null.

Référencé par FinderIndexerToken\__construct().

parse()

static parse (   $input,   $format = 'html'  )

static

Method to parse input into plain text.

Paramètres

string	$input	The raw input.
string	$format	The format of the input. [optional]

Renvoie

string The parsed input.

Depuis

2.5

Exceptions

Exception

on invalid parser.

Références $format, $input, et FinderIndexerParser\getInstance().

Référencé par FinderIndexerDriverPostgresql\index(), FinderIndexerDriverSqlsrv\index(), FinderIndexerDriverMysql\index(), et FinderIndexer\tokenizeToDbShort().

prepareContent()

static prepareContent (   $text,   $params = null, FinderIndexerResult  $item = null  )

static

Method to process content text using the onContentPrepare event trigger.

Paramètres

string	$text	The content to process.
Registry	$params	The parameters object. [optional]
FinderIndexerResult	$item	The item which get prepared. [optional]

Renvoie

string The processed content.

Depuis

2.5

Références $content, $dispatcher, $item, $params, $text, et JEventDispatcher\getInstance().

Référencé par PlgFinderCategories\index(), et PlgFinderContent\index().

stem()

static stem (   $token,   $lang  )

static

Method to get the base word of a token. This method uses the public FinderIndexerHelper::$stemmer object if it is set. If no stemmer is set, the original token is returned.

Paramètres

string	$token	The token to stem.
string	$lang	The language of the token.

Renvoie

string The root token.

Depuis

2.5

Références $lang.

Référencé par FinderIndexerToken\__construct().

tokenize()

static tokenize (   $input,   $lang,   $phrase = false  )

static

Method to tokenize a text string.

Paramètres

string	$input	The input to tokenize.
string	$lang	The language of the input.
boolean	$phrase	Flag to indicate whether input could be a phrase. [optional]

Renvoie

array|FinderIndexerToken An array of FinderIndexerToken objects or a single FinderIndexerToken object.

Depuis

2.5

Références $i, $input, $lang, $n, ENT_QUOTES, et null.

Référencé par FinderIndexerQuery\processString(), et FinderIndexer\tokenizeToDbShort().

Documentation des champs

$stemmer

$stemmer

static

Référencé par FinderIndexer\getState(), et FinderModelSearch\populateState().

$stemmerOK

$stemmerOK

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• administrator/components/com_finder/helpers/indexer/helper.php