Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe FinderIndexer

Liste de tous les membres

Fonctions membres publiques statiques

static getState ()
static setState ($data)
static resetState ()
static index ($item, $format= 'html')
static remove ($linkId)
static optimize ()

Attributs publics

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 statiques

static getSignature ($item)
static tokenizeToDB ($input, $context, $lang, $format)
static addTokensToDB ($tokens, $context= '')
static toggleTables ($memory)

Documentation des fonctions membres

static FinderIndexer::addTokensToDB (   $tokens,
  $context = '' 
)
staticprotected

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 $db, et $query.

Référencé par tokenizeToDB().

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::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, $state, et getState().

+ Voici le graphe d'appel pour cette fonction :

static FinderIndexer::index (   $item,
  $format = 'html' 
)
static

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.

Références $count, $db, $i, $item, $link, $query, $state, $suffix, FinderIndexerTaxonomy\addMap(), FinderIndexerTaxonomy\addNode(), getState(), null, FinderIndexerHelper\parse(), FinderIndexerTaxonomy\removeMaps(), JFile\stripExt(), toggleTables(), et tokenizeToDB().

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 FinderIndexer::optimize ( )
static

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.

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

Référencé par FinderControllerIndexer\optimize().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::remove (   $linkId)
static

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, $state, getState(), FinderIndexerTaxonomy\removeMaps(), et FinderIndexerTaxonomy\removeOrphanNodes().

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

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::resetState ( )
static

Method to reset the indexer state.

Renvoie:
void
Depuis:
2.5

Références $state, JFactory\getSession(), et null.

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

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::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, $state, et JFactory\getSession().

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

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::toggleTables (   $memory)
staticprotected

Method to switch the token tables from Memory tables to MyISAM tables when they are close to running out of memory.

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

Références $db, $state, et elseif.

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

+ Voici le graphe des appelants de cette fonction :

static FinderIndexer::tokenizeToDB (   $input,
  $context,
  $lang,
  $format 
)
staticprotected

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 $count, $lang, $state, addTokensToDB(), elseif, null, FinderIndexerHelper\parse(), toggleTables(), FinderIndexerHelper\tokenize(), et JString\trim().

Référencé par index().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :


Documentation des données membres

FinderIndexer::$profiler
static
FinderIndexer::$state
static
const FinderIndexer::MISC_CONTEXT = 5
const FinderIndexer::PATH_CONTEXT = 4
const FinderIndexer::TEXT_CONTEXT = 2
const FinderIndexer::TITLE_CONTEXT = 1

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