eZSearch Class Reference

eZSearch handles indexing of objects to the search engine More...

List of all members.

Public Member Functions
	eZSearch ()
Static Public Member Functions
static	addNodeAssignment ($mainNodeID, $objectID, $nodeAssignmentIDList)
static	addObject ($contentObject, $commit=true)
static	buildSearchArray ()
static	cleanup ()
static	getEngine ()
static	needCommit ()
static	needRemoveWithUpdate ()
static	normalizeText ($text)
static	removeNodeAssignment ($mainNodeID, $newMainNodeID, $objectID, $nodeAssigmentIDList)
static	removeObject ($contentObject, $commit=true)
static	search ($searchText, $params, $searchTypes=array())
static	swapNode ($nodeID, $selectedNodeID, $nodeIdList=array())
static	updateNodeSection ($nodeID, $sectionID)
static	updateNodeVisibility ($nodeID, $action)
static	updateObjectState ($objectID, $objectStateList)

---

Detailed Description

eZSearch handles indexing of objects to the search engine

Definition at line 38 of file ezsearch.php.

---

Member Function Documentation

static eZSearch::addNodeAssignment	(	$	mainNodeID,
		$	objectID,
		$	nodeAssignmentIDList
	)		[static]

Definition at line 530 of file ezsearch.php.

static eZSearch::addObject	(	$	contentObject,
		$	commit = true
	)		[static]

Will index the content object to the search engine. A commit parameter is added since 4.1 to accomodate requirements of several search plugins

Definition at line 103 of file ezsearch.php.

static eZSearch::buildSearchArray

(

)

[static]

returns search parameters in array based on supported search types and post variables

Definition at line 146 of file ezsearch.php.

static eZSearch::cleanup

(

)

[static]

Tells the current search engine to cleanup up all data.

Definition at line 435 of file ezsearch.php.

eZSearch::eZSearch

(

)

Definition at line 40 of file ezsearch.php.

static eZSearch::getEngine

(

)

[static]

Get object instance of eZSearch engine to use.

Returns:

instance of eZSearch class.

Definition at line 451 of file ezsearch.php.

Referenced by addNodeAssignment(), addObject(), buildSearchArray(), cleanup(), needCommit(), needRemoveWithUpdate(), normalizeText(), removeNodeAssignment(), removeObject(), search(), swapNode(), updateNodeSection(), updateNodeVisibility(), and updateObjectState().

static eZSearch::needCommit

(

)

[static]

determine how to pass the commit argument, for deletes and updates maybe this needs to be further splitted

Definition at line 51 of file ezsearch.php.

static eZSearch::needRemoveWithUpdate

(

)

[static]

See if a remove is needed in an update of content objects

Definition at line 69 of file ezsearch.php.

static eZSearch::normalizeText

(

$

text

)

[static]

Definition at line 130 of file ezsearch.php.

static eZSearch::removeNodeAssignment	(	$	mainNodeID,
		$	newMainNodeID,
		$	objectID,
		$	nodeAssigmentIDList
	)		[static]

Definition at line 542 of file ezsearch.php.

static eZSearch::removeObject	(	$	contentObject,
		$	commit = true
	)		[static]

Will remove the index from the given object from the search engine A commit parameter is added since 4.1 to accomodate requirements of several search plugins

Definition at line 88 of file ezsearch.php.

static eZSearch::search	(	$	searchText,
		$	params,
		$	searchTypes = array()
	)		[static]

Runs a query to the search engine.

Definition at line 117 of file ezsearch.php.

static eZSearch::swapNode	(	$	nodeID,
		$	selectedNodeID,
		$	nodeIdList = array()
	)		[static]

Definition at line 566 of file ezsearch.php.

static eZSearch::updateNodeSection	(	$	nodeID,
		$	sectionID
	)		[static]

Definition at line 506 of file ezsearch.php.

static eZSearch::updateNodeVisibility	(	$	nodeID,
		$	action
	)		[static]

Definition at line 518 of file ezsearch.php.

static eZSearch::updateObjectState	(	$	objectID,
		$	objectStateList
	)		[static]

Definition at line 554 of file ezsearch.php.

---

The documentation for this class was generated from the following file:

• ezsearch.php