kernel/classes/ezsearch.php
Classes
\eZSearch
Package:
Methods
addNodeAssignment(
int $mainNodeID, int $objectID, array $nodeAssignmentIDList
)
:
false | mixed
static
Notifies search engine about new node assignments added
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $mainNodeID | int | |
| $objectID | int | |
| $nodeAssignmentIDList | array |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
addObject(
$contentObject, $commit
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $contentObject | ||
| $commit |
buildSearchArray(
)
:
void
static
cleanup(
)
:
void
static
eZSearch(
)
:
voidgetEngine(
)
:
void
static
needCommit(
)
:
void
static
needRemoveWithUpdate(
)
:
void
static
normalizeText(
$text
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $text |
removeNodeAssignment(
int $mainNodeID, int $newMainNodeID, int $objectID, array $nodeAssigmentIDList
)
:
false | mixed
static
Notifies search engine about removed node assignments and what the new main node is (same if not changed)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $mainNodeID | int | |
| $newMainNodeID | int | |
| $objectID | int | |
| $nodeAssigmentIDList | array |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
removeNodes(
array $nodeIdList
)
:
false | mixed
static
Notifies search engine about nodes being removed
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $nodeIdList | array | Array of node ID to remove. |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
removeObject(
$contentObject, $commit
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $contentObject | ||
| $commit |
search(
$searchText, $params, $searchTypes
=
array()
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $searchText | ||
| $params | ||
| $searchTypes |
swapNode(
int $nodeID, int $selectedNodeID, array $nodeIdList
=
array()
)
:
false | mixed
static
Notifies search engine about an swap node operation
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $nodeID | int | |
| $selectedNodeID | int | |
| $nodeIdList | array |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
updateNodeSection(
int $nodeID, int $sectionID
)
:
false | mixed
static
Notifies search engine about section changes
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $nodeID | int | |
| $sectionID | int |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
updateNodeVisibility(
int $nodeID, string $action
)
:
false | mixed
static
Notifies search engine about node visibility changes
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $nodeID | int | |
| $action | string | "hide" or "show" |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |
updateObjectState(
int $objectID, array $objectStateList
)
:
false | mixed
static
Notifies search engine about updates to object states
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $objectID | int | |
| $objectStateList | array |
| Type | Description |
|---|---|
| false | mixed | False in case method is undefined, otherwise return the result of the search engine call |