Docs For Class FinderIndexerTaxonomy

Description

Stemmer base class for the Finder indexer package.

since: 2.5

Located in /administrator/components/com_finder/helpers/indexer/taxonomy.php (line 19)

Variable Summary

static array $branches

static array $nodes

Method Summary

static integer addBranch (string $title, [integer $state = 1], [integer $access = 1])

static boolean addMap (integer $linkId, integer $nodeId)

static integer addNode (string $branch, string $title, [integer $state = 1], [integer $access = 1])

static array getBranchTitles ()

static mixed getNodeByTitle (string $branch, string $title)

static boolean removeMaps (integer $linkId)

static integer removeOrphanNodes ()

static boolean storeNode (object $item)

Variables

static array $branches = array() (line 27)

An internal cache of taxonomy branch data.

since: 2.5
access: public

static array $nodes = array() (line 35)

An internal cache of taxonomy node data.

since: 2.5
access: public

Methods

static addBranch (line 49)

Method to add a branch to the taxonomy tree.

return: The id of the branch.
throws: Exception on database error.
since: 2.5
access: public

static integer addBranch (string $title, [integer $state = 1], [integer $access = 1])

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]

static addMap (line 202)

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

return: True on success.
throws: Exception on database error.
since: 2.5
access: public

static boolean addMap (integer $linkId, integer $nodeId)

integer $linkId: The link to map to.
integer $nodeId: The node to map to.

static addNode (line 125)

Method to add a node to the taxonomy tree.

return: The id of the node.
throws: Exception on database error.
since: 2.5
access: public

static integer addNode (string $branch, string $title, [integer $state = 1], [integer $access = 1])

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]

static getBranchTitles (line 240)

Method to get the title of all taxonomy branches.

return: An array of branch titles.
throws: Exception on database error.
since: 2.5
access: public

static array getBranchTitles ()

static getNodeByTitle (line 274)

Method to find a taxonomy node in a branch.

return: Integer id on success, null on no match.
throws: Exception on database error.
since: 2.5
access: public

static mixed getNodeByTitle (string $branch, string $title)

string $branch: The branch to search.
string $title: The title of the node.

static removeMaps (line 311)

Method to remove map entries for a link.

return: True on success.
throws: Exception on database error.
since: 2.5
access: public

static boolean removeMaps (integer $linkId)

integer $linkId: The link to remove.

static removeOrphanNodes (line 332)

Method to remove orphaned taxonomy nodes and branches.

return: The number of deleted rows.
throws: Exception on database error.
since: 2.5
access: public

static integer removeOrphanNodes ()

static storeNode (line 357)

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

return: True on success.
throws: Exception on database error.
since: 2.5
access: protected

static boolean storeNode (object $item)

object $item: The item to store.