Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe FinderIndexer
+ Graphe d'héritage de FinderIndexer:

Fonctions membres publiques

 __construct ()
 
 index ($item, $format='html')
 
 remove ($linkId)
 
 optimize ()
 

Fonctions membres publiques statiques

static getInstance ()
 
static getState ()
 
static setState ($data)
 
static resetState ()
 

Champs de données

const TITLE_CONTEXT = 1
 
const TEXT_CONTEXT = 2
 
const META_CONTEXT = 3
 
const PATH_CONTEXT = 4
 
const MISC_CONTEXT = 5
 

Attributs publics statiques

static $state
 
static $profiler
 

Fonctions membres protégées

 tokenizeToDb ($input, $context, $lang, $format)
 
 addTokensToDb ($tokens, $context='')
 
 toggleTables ($memory)
 

Fonctions membres protégées statiques

static getSignature ($item)
 

Attributs protégés

 $db
 
 $addTokensToDbQueryTemplate
 

Fonctions membres privées

 tokenizeToDbShort ($input, $context, $lang, $format, $count)
 

Description détaillée

Main indexer class for the Finder indexer package.

The indexer class provides the core functionality of the Finder search engine. It is responsible for adding and updating the content links table; extracting and scoring tokens; and maintaining all referential information for the content.

Note: All exceptions thrown from within this class should be caught by the controller.

Depuis
2.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

FinderIndexer constructor.

Depuis
3.8.0

Références $db.

Documentation des fonctions membres

◆ addTokensToDb()

addTokensToDb (   $tokens,
  $context = '' 
)
protected

Method to add a set of tokens to the database.

Paramètres
mixed$tokensAn array or single FinderIndexerToken object.
mixed$contextThe context of the tokens. See context constants. [optional]
Renvoie
integer The number of tokens inserted into the database.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ getInstance()

static getInstance ( )
static

Returns a reference to the FinderIndexer object.

Renvoie
FinderIndexer instance based on the database driver
Depuis
3.0
Exceptions
RuntimeExceptionif driver class for indexer not present.

Références $class, $path, et JLoader\register().

Référencé par FinderIndexerAdapter\__construct(), et FinderControllerIndexer\optimize().

◆ getSignature()

static getSignature (   $item)
staticprotected

Method to get a content item's signature.

Paramètres
object$itemThe content item to index.
Renvoie
string The content item's signature.
Depuis
2.5

Références $config, $item, et $state.

◆ getState()

◆ index()

index (   $item,
  $format = 'html' 
)
abstract

Method to index a content item.

Paramètres
FinderIndexerResult$itemThe content item to index.
string$formatThe format of the content. [optional]
Renvoie
integer The ID of the record in the links table.
Depuis
2.5
Exceptions
Exceptionon database error.

◆ optimize()

optimize ( )
abstract

Method to optimize the index. We use this method to remove unused terms and any other optimizations that might be necessary.

Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

◆ remove()

remove (   $linkId)

Method to remove a link from the index.

Paramètres
integer$linkIdThe id of the link.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $db, $i, $query, FinderIndexerTaxonomy\removeMaps(), et FinderIndexerTaxonomy\removeOrphanNodes().

◆ resetState()

static resetState ( )
static

Method to reset the indexer state.

Renvoie
void
Depuis
2.5

Références $state, et null.

Référencé par FinderCli\index(), et FinderControllerIndexer\start().

◆ setState()

static setState (   $data)
static

Method to set the indexer state.

Paramètres
object$dataA new indexer state object.
Renvoie
boolean True on success, false on failure.
Depuis
2.5

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

Référencé par FinderControllerIndexer\batch(), FinderIndexerAdapter\onBuildIndex(), et FinderIndexerAdapter\onStartIndex().

◆ toggleTables()

toggleTables (   $memory)
protected

Method to switch the token tables from Memory tables to Disk tables when they are close to running out of memory. Since this is not supported/implemented in all DB-drivers, the default is a stub method, which simply returns true.

Paramètres
boolean$memoryFlag to control how they should be toggled.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

◆ tokenizeToDb()

tokenizeToDb (   $input,
  $context,
  $lang,
  $format 
)
protected

Method to parse input, tokenize it, and then add it to the database.

Paramètres
mixed$inputString or resource to use as input. A resource input will automatically be chunked to conserve memory. Strings will be chunked if longer than 2K in size.
integer$contextThe context of the input. See context constants.
string$langThe language of the input.
string$formatThe format of the input.
Renvoie
integer The number of tokens extracted from the input.
Depuis
2.5

Références $buffer, $context, $count, $format, $input, $lang, et null.

◆ tokenizeToDbShort()

tokenizeToDbShort (   $input,
  $context,
  $lang,
  $format,
  $count 
)
private

Method to parse input, tokenise it, then add the tokens to the database.

Paramètres
string$inputString to parse, tokenise and add to database.
integer$contextThe context of the input. See context constants.
string$langThe language of the input.
string$formatThe format of the input.
integer$countThe number of tokens processed so far.
Renvoie
integer Cummulative number of tokens extracted from the input so far.
Depuis
3.7.0

Références $context, $count, $format, $input, $lang, $state, FinderIndexerHelper\parse(), et FinderIndexerHelper\tokenize().

Documentation des champs

◆ $addTokensToDbQueryTemplate

$addTokensToDbQueryTemplate
protected

◆ $db

$db
protected

◆ $profiler

$profiler
static

◆ $state

$state
static

◆ META_CONTEXT

◆ MISC_CONTEXT

const MISC_CONTEXT = 5

◆ PATH_CONTEXT

const PATH_CONTEXT = 4

◆ TEXT_CONTEXT

const TEXT_CONTEXT = 2

◆ TITLE_CONTEXT

const TITLE_CONTEXT = 1

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