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 FinderIndexerTaxonomy

Fonctions membres publiques statiques

static addBranch ($title, $state=1, $access=1)
 
static addNode ($branch, $title, $state=1, $access=1)
 
static addMap ($linkId, $nodeId)
 
static getBranchTitles ()
 
static getNodeByTitle ($branch, $title)
 
static removeMaps ($linkId)
 
static removeOrphanNodes ()
 

Attributs publics statiques

static $branches = array()
 
static $nodes = array()
 

Fonctions membres protégées statiques

static storeNode ($item)
 

Description détaillée

Stemmer base class for the Finder indexer package.

Depuis
2.5

Documentation des fonctions membres

◆ addBranch()

static addBranch (   $title,
  $state = 1,
  $access = 1 
)
static

Method to add a branch to the taxonomy tree.

Paramètres
string$titleThe title of the branch.
integer$stateThe published state of the branch. [optional]
integer$accessThe access state of the branch. [optional]
Renvoie
integer The id of the branch.
Depuis
2.5
Exceptions
Exceptionon database error.

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

◆ addMap()

static addMap (   $linkId,
  $nodeId 
)
static

Method to add a map entry between a link and a taxonomy node.

Paramètres
integer$linkIdThe link to map to.
integer$nodeIdThe node to map to.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

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

◆ addNode()

static addNode (   $branch,
  $title,
  $state = 1,
  $access = 1 
)
static

Method to add a node to the taxonomy tree.

Paramètres
string$branchThe title of the branch to store the node in.
string$titleThe title of the node.
integer$stateThe published state of the node. [optional]
integer$accessThe access state of the node. [optional]
Renvoie
integer The id of the node.
Depuis
2.5
Exceptions
Exceptionon database error.

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

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

◆ getBranchTitles()

static getBranchTitles ( )
static

Method to get the title of all taxonomy branches.

Renvoie
array An array of branch titles.
Depuis
2.5
Exceptions
Exceptionon database error.

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

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

◆ getNodeByTitle()

static getNodeByTitle (   $branch,
  $title 
)
static

Method to find a taxonomy node in a branch.

Paramètres
string$branchThe branch to search.
string$titleThe title of the node.
Renvoie
mixed Integer id on success, null on no match.
Depuis
2.5
Exceptions
Exceptionon database error.

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

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

◆ removeMaps()

static removeMaps (   $linkId)
static

Method to remove map entries for a link.

Paramètres
integer$linkIdThe link to remove.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

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

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

◆ removeOrphanNodes()

static removeOrphanNodes ( )
static

Method to remove orphaned taxonomy nodes and branches.

Renvoie
integer The number of deleted rows.
Depuis
2.5
Exceptions
Exceptionon database error.

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

Référencé par FinderIndexerDriverMysql\optimize(), FinderIndexerDriverPostgresql\optimize(), FinderIndexerDriverSqlsrv\optimize(), FinderIndexer\remove(), et FinderIndexerDriverSqlsrv\remove().

◆ storeNode()

static storeNode (   $item)
staticprotected

Method to store a node to the database. This method will accept either a branch or a node.

Paramètres
object$itemThe item to store.
Renvoie
boolean True on success.
Depuis
2.5
Exceptions
Exceptionon database error.

Références $db, et $item.

Documentation des champs

◆ $branches

$branches = array()
static

◆ $nodes

$nodes = array()
static

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