eZPublishCommunityProject(LegacyStack)  2013.5
eZSearch Class Reference

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. More...
 
static addObject ($contentObject, $commit=true)
 Adds object $contentObject to the search database. More...
 
static buildSearchArray ()
 
static cleanup ()
 
static getEngine ()
 Get object instance of eZSearch engine to use. More...
 
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) More...
 
static removeNodes (array $nodeIdList)
 Notifies search engine about nodes being removed. More...
 
static removeObject ($contentObject, $commit=true)
 Removes object $contentObject from the search database. More...
 
static removeObjectById ($contentObjectId, $commit=true)
 Removes a content object by Id from the search database. More...
 
static search ($searchText, $params, $searchTypes=array())
 
static swapNode ($nodeID, $selectedNodeID, $nodeIdList=array())
 Notifies search engine about an swap node operation. More...
 
static updateNodeSection ($nodeID, $sectionID)
 Notifies search engine about section changes. More...
 
static updateNodeVisibility ($nodeID, $action)
 Notifies search engine about node visibility changes. More...
 
static updateObjectsSection (array $objectIDs, $sectionID)
 Notifies search engine about the change of section of a set of objects. More...
 
static updateObjectState ($objectID, $objectStateList)
 Notifies search engine about updates to object states. More...
 

Detailed Description

eZSearch handles indexing of objects to the search engine

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

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

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

Adds object $contentObject to the search database.

Parameters
eZContentObject$contentObjectObject to add to search engine
bool$commitWhether to commit after adding the object
Returns
bool True if the operation succeed.

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

static eZSearch::buildSearchArray ( )
static

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

Referenced by eZContentFunctionCollection\fetchContentSearch().

static eZSearch::cleanup ( )
static

Tells the current search engine to cleanup up all data.

eZSearch::eZSearch ( )
static eZSearch::needCommit ( )
static

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

Referenced by eZContentOperationCollection\registerSearchObject().

static eZSearch::needRemoveWithUpdate ( )
static

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

Referenced by eZContentOperationCollection\registerSearchObject().

static eZSearch::normalizeText (   $text)
static
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

Referenced by eZContentObjectTreeNodeOperations\move().

static eZSearch::removeNodes ( array  $nodeIdList)
static

Notifies search engine about nodes being removed.

Since
4.1
Parameters
array$nodeIdListArray of node ID to remove.
Returns
false|mixed False in case method is undefined, otherwise return the result of the search engine call

Referenced by eZContentOperationCollection\removeNodes().

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

Removes object $contentObject from the search database.

Deprecated:
Since 5.0, use removeObjectById()
Parameters
eZContentObject$contentObjectthe content object to remove
bool$commitWhether to commit after removing the object
Returns
bool True if the operation succeed.

Referenced by eZContentObject\purge(), eZContentOperationCollection\registerSearchObject(), and eZContentObject\removeThis().

static eZSearch::removeObjectById (   $contentObjectId,
  $commit = true 
)
static

Removes a content object by Id from the search database.

Since
5.0
Parameters
int$contentObjectIdthe content object to remove by id
bool$commitWhether to commit after removing the object
Returns
bool True if the operation succeed.
static eZSearch::search (   $searchText,
  $params,
  $searchTypes = array() 
)
static

Runs a query to the search engine.

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

Referenced by eZContentOperationCollection\swapNode().

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

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

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

Referenced by eZContentOperationCollection\updateObjectState().


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