Class

eZSearch

class eZSearch

Methods

static ezpSearchEngine|bool getEngine()

Get object instance of eZSearch engine to use.

static false|mixed updateObjectsSection(array $objectIDs, int $sectionID)

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

static false|mixed updateNodeSection(int $nodeID, int $sectionID)

Notifies search engine about section changes

static false|mixed updateNodeVisibility(int $nodeID, string $action)

Notifies search engine about node visibility changes

static false|mixed addNodeAssignment(int $mainNodeID, int $objectID, array $nodeAssignmentIDList, bool $isMoved = false)

Notifies search engine about new node assignments added

static false|mixed removeNodeAssignment(int $mainNodeID, int $newMainNodeID, int $objectID, array $nodeAssigmentIDList)

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

static false|mixed removeNodes(array $nodeIdList)

Notifies search engine about nodes being removed

static false|mixed updateObjectState(int $objectID, array $objectStateList)

Notifies search engine about updates to object states

static false|mixed swapNode(int $nodeID, int $selectedNodeID, array $nodeIdList = array())

Notifies search engine about an swap node operation

Details

at line 447
static public ezpSearchEngine|bool getEngine()

Get object instance of eZSearch engine to use.

Return Value

ezpSearchEngine|bool Returns false (+ writes debug) if no engine was found

at line 504
static public false|mixed updateObjectsSection(array $objectIDs, int $sectionID)

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

Parameters

array $objectIDs
int $sectionID

Return Value

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

at line 522
static public false|mixed updateNodeSection(int $nodeID, int $sectionID)

Notifies search engine about section changes

Parameters

int $nodeID
int $sectionID

Return Value

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

at line 542
static public false|mixed updateNodeVisibility(int $nodeID, string $action)

Notifies search engine about node visibility changes

Parameters

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

Return Value

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

at line 564
static public false|mixed addNodeAssignment(int $mainNodeID, int $objectID, array $nodeAssignmentIDList, bool $isMoved = false)

Notifies search engine about new node assignments added

Parameters

int $mainNodeID
int $objectID
array $nodeAssignmentIDList
bool $isMoved true if node is being moved

Return Value

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

at line 586
static public false|mixed removeNodeAssignment(int $mainNodeID, int $newMainNodeID, int $objectID, array $nodeAssigmentIDList)

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

Return Value

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

at line 605
static public false|mixed removeNodes(array $nodeIdList)

Notifies search engine about nodes being removed

Parameters

array $nodeIdList Array of node ID to remove.

Return Value

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

at line 625
static public false|mixed updateObjectState(int $objectID, array $objectStateList)

Notifies search engine about updates to object states

Parameters

int $objectID
array $objectStateList

Return Value

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

at line 646
static public false|mixed swapNode(int $nodeID, int $selectedNodeID, array $nodeIdList = array())

Notifies search engine about an swap node operation

Parameters

int $nodeID
int $selectedNodeID
array $nodeIdList

Return Value

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