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

Public Member Functions
	eZSearch ()
Static Public Member Functions
static	addNodeAssignment ($mainNodeID, $objectID, $nodeAssignmentIDList)
	Notifies search engine about new node assignments added.
static	addObject ($contentObject, $commit=true)
	Adds object $contentObject to the search database.
static	buildSearchArray ()
static	cleanup ()
static	getEngine ()
static	needCommit ()
static	needRemoveWithUpdate ()
static	normalizeText ($text)
static	removeNodeAssignment ($mainNodeID, $newMainNodeID, $objectID, $nodeAssigmentIDList)
	Notifies search engine about removed node assignments and what the new main node is (same if not changed)
static	removeNodes (array $nodeIdList)
	Notifies search engine about nodes being removed.
static	removeObject ($contentObject, $commit=true)
	Removes object $contentObject from the search database.
static	search ($searchText, $params, $searchTypes=array())
static	swapNode ($nodeID, $selectedNodeID, $nodeIdList=array())
	Notifies search engine about an swap node operation.
static	updateNodeSection ($nodeID, $sectionID)
	Notifies search engine about section changes.
static	updateNodeVisibility ($nodeID, $action)
	Notifies search engine about node visibility changes.
static	updateObjectsSection (array $objectIDs, $sectionID)
	Notifies search engine about the change of section of a set of objects.
static	updateObjectState ($objectID, $objectStateList)
	Notifies search engine about updates to object states.

Detailed Description

eZSearch handles indexing of objects to the search engine

Definition at line 18 of file ezsearch.php.

Member Function Documentation

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

Notifies search engine about new node assignments added.

Since:: 4.1

Parameters:

int	$mainNodeID
int	$objectID
array	$nodeAssignmentIDList

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 549 of file ezsearch.php.

Referenced by eZContentOperationCollection\addAssignment(), and eZContentObjectTreeNodeOperations\move().

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

Adds object $contentObject to the search database.

Parameters:

eZContentObject	$contentObject	Object to add to search engine
bool	$commit	Whether to commit after adding the object

Returns:: bool True if the operation succeed.

Definition at line 83 of file ezsearch.php.

Referenced by eZContentOperationCollection\registerSearchObject(), and eZContentObjectTreeNode\removeNodeFromTree().

static eZSearch::buildSearchArray ( ) [static]

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

Definition at line 128 of file ezsearch.php.

Referenced by eZContentFunctionCollection\fetchContentSearch().

static eZSearch::cleanup ( ) [static]

Tells the current search engine to cleanup up all data.

Definition at line 417 of file ezsearch.php.

eZSearch::eZSearch ( )

Definition at line 20 of file ezsearch.php.

static eZSearch::getEngine ( ) [static]

Get object instance of eZSearch engine to use.

Returns:: instance of eZSearch class.

Definition at line 433 of file ezsearch.php.

Referenced by addNodeAssignment(), addObject(), buildSearchArray(), cleanup(), needCommit(), needRemoveWithUpdate(), normalizeText(), eZContentOperationCollection\removeAssignment(), removeNodeAssignment(), removeNodes(), eZContentOperationCollection\removeNodes(), removeObject(), search(), swapNode(), updateNodeSection(), updateNodeVisibility(), updateObjectsSection(), 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 31 of file ezsearch.php.

Referenced by eZContentOperationCollection\registerSearchObject().

static eZSearch::needRemoveWithUpdate ( ) [static]

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

Definition at line 46 of file ezsearch.php.

Referenced by eZContentOperationCollection\registerSearchObject().

static eZSearch::normalizeText ( $ text ) [static]

Definition at line 112 of file ezsearch.php.

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

Notifies search engine about removed node assignments and what the new main node is (same if not changed)

Since:: 4.1

Parameters:

int	$mainNodeID
int	$newMainNodeID
int	$objectID
array	$nodeAssigmentIDList

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 571 of file ezsearch.php.

Referenced by eZContentObjectTreeNodeOperations\move(), and eZContentOperationCollection\removeAssignment().

static eZSearch::removeNodes ( array $ nodeIdList ) [static]

Notifies search engine about nodes being removed.

Since:: 4.1

Parameters:

array $nodeIdList Array of node ID to remove.

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 590 of file ezsearch.php.

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

Removes object $contentObject from the search database.

Parameters:

eZContentObject	$contentObject	the content object to remove
bool	$commit	Whether to commit after removing the object

Returns:: bool True if the operation succeed.

Definition at line 64 of file ezsearch.php.

Referenced by eZContentOperationCollection\registerSearchObject().

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

Runs a query to the search engine.

Definition at line 99 of file ezsearch.php.

Referenced by eZContentFunctionCollection\fetchContentSearch().

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

Notifies search engine about an swap node operation.

Since:: 4.1

Parameters:

int	$nodeID
int	$selectedNodeID
array	$nodeIdList

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 631 of file ezsearch.php.

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

Notifies search engine about section changes.

Since:: 4.1

Parameters:

int	$nodeID
int	$sectionID

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 508 of file ezsearch.php.

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

Notifies search engine about node visibility changes.

Since:: 4.1

Parameters:

int	$nodeID
string	$action	"hide" or "show"

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 528 of file ezsearch.php.

Referenced by eZContentOperationCollection\changeHideStatus().

static eZSearch::updateObjectsSection	(	array $	objectIDs,
		$	sectionID
	)		`[static]`

Notifies search engine about the change of section of a set of objects.

Since:: 4.6

Parameters:

array	$objectIDs
int	$sectionID

Returns:: false|mixed false in case method is undefined, otherwise return the result of the search engine call

Definition at line 490 of file ezsearch.php.

Referenced by eZContentObjectTreeNode\assignSectionToSubTree().

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

Notifies search engine about updates to object states.

Since:: 4.1

Parameters:

int	$objectID
array	$objectStateList

Returns:: false|mixed False in case method is undefined, otherwise return the result of the search engine call

Definition at line 610 of file ezsearch.php.

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

ezsearch.php

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation