Référence de la classe FinderIndexerHelper

Liste de tous les membres

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)

Attributs publics statiques
static	$stemmer

---

Documentation des fonctions membres

static FinderIndexerHelper::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().

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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.

Référencé par isCommon().

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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 an FinderIndexerResult object.

Renvoie:

boolean True on success, false on failure.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $dispatcher, JDispatcher\getInstance(), et JPluginHelper\importPlugin().

Référencé par plgFinderCategories\index(), plgFinderContent\index(), plgFinderWeblinks\index(), plgFinderNewsfeeds\index(), et plgFinderContacts\index().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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

Références $config, $route, $uri, $url, JURI\base(), JFactory\getConfig(), JRouter\getInstance(), jimport(), et JPATH_SITE.

Référencé par plgFinderCategories\index(), plgFinderContent\index(), plgFinderWeblinks\index(), plgFinderNewsfeeds\index(), plgFinderContacts\index(), et plgFinderContacts\setup().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::getDefaultLanguage ( )

static

Method to get the default language for the site.

Renvoie:

string The default language string.

Depuis:

2.5

Références $lang, et JComponentHelper\getParams().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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, $lang, JString\strpos(), et JString\substr().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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, $lang, et getCommonWords().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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 FinderIndexerParser\getInstance().

Référencé par FinderIndexer\index(), et FinderIndexer\tokenizeToDB().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::prepareContent (   $text,   $params = null  )

static

Method to process content text using the onContentPrepare event trigger.

Paramètres:

string	$text	The content to process.
JRegistry	$params	The parameters object. [optional]

Renvoie:

string The processed content.

Depuis:

2.5

Références $dispatcher, $params, $text, JDispatcher\getInstance(), JTable\getInstance(), et JPluginHelper\importPlugin().

Référencé par plgFinderCategories\index(), et plgFinderContent\index().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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, JString\strpos(), JString\substr(), et JString\trim().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static FinderIndexerHelper::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 An array of FinderIndexerToken objects.

Depuis:

2.5

Références $i, $lang, $n, ENT_QUOTES, getPrimaryLanguage(), null, JString\str_ireplace(), JString\strlen(), JString\strtolower(), et JString\trim().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

---

Documentation des données membres

FinderIndexerHelper::$stemmer

static

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

---

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

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