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	$title	The title of the branch.
integer	$state	The published state of the branch. [optional]
integer	$access	The access state of the branch. [optional]

Renvoie

integer The id of the branch.

Depuis

2.5

Exceptions

Exception

on 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	$linkId	The link to map to.
integer	$nodeId	The node to map to.

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on 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	$branch	The title of the branch to store the node in.
string	$title	The title of the node.
integer	$state	The published state of the node. [optional]
integer	$access	The access state of the node. [optional]

Renvoie

integer The id of the node.

Depuis

2.5

Exceptions

Exception

on 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

Exception

on 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	$branch	The branch to search.
string	$title	The title of the node.

Renvoie

mixed Integer id on success, null on no match.

Depuis

2.5

Exceptions

Exception

on 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

$linkId

The link to remove.

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on 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

Exception

on database error.

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

Référencé par FinderIndexerDriverPostgresql\optimize(), FinderIndexerDriverMysql\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

$item

The item to store.

Renvoie

boolean True on success.

Depuis

2.5

Exceptions

Exception

on 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 :

• taxonomy.php