eZPublish  4.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)
 
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) More...
 
static removeNodes (array $nodeIdList)
 Notifies search engine about nodes being removed. More...
 
static removeObject ($contentObject, $commit=true)
 
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 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.

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

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

Referenced by eZContentOperationCollection\registerSearchObject().

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)

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(), and eZContentOperationCollection\removeAssignment().

static eZSearch::removeNodes ( array  $nodeIdList)
static

Notifies search engine about nodes being removed.

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

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

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

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.

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.

Parameters
int$nodeID
int$sectionID
Returns
false|mixed False in case method is undefined, otherwise return the result of the search engine call

Referenced by eZContentOperationCollection\updateSection().

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

Notifies search engine about node visibility changes.

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::updateObjectState (   $objectID,
  $objectStateList 
)
static

Notifies search engine about updates to object states.

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: