kernel/classes/ezsearch.php

Show:

inherited

Classes
- \eZSearch

Table of Contents

File containing the eZSearch class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZSearch
jump to top

Package: kernel

File containing the eZSearch class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Methods

addNodeAssignment(
          int $mainNodeID, int $objectID, array $nodeAssignmentIDList
          )
        
        :
          false | mixed

static

Notifies search engine about new node assignments added

Parameters

Name	Type	Description
$mainNodeID	int
$objectID	int
$nodeAssignmentIDList	array

Returns

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

Details

Since: 4.1

addObject(
          \eZContentObject $contentObject, bool $commit
              =
              true
          )
        
        :
          bool

static

Adds object $contentObject to the search database.

Parameters

Name	Type	Description
$contentObject	\eZContentObject	Object to add to search engine
$commit	bool	Whether to commit after adding the object

Returns

Type	Description
bool	True if the operation succeed.

buildSearchArray(
          
          )
        
        :
          void

static

cleanup(
          
          )
        
        :
          void

static

eZSearch(
          
          )
        
        :
          void

getEngine(
          
          )
        
        :
          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

Name	Type	Description
$mainNodeID	int
$newMainNodeID	int
$objectID	int
$nodeAssigmentIDList	array

Returns

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

Details

Since: 4.1

removeNodes(
          array $nodeIdList
          )
        
        :
          false | mixed

static

Notifies search engine about nodes being removed

Parameters

Name	Type	Description
$nodeIdList	array	Array of node ID to remove.

Returns

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

Details

Since: 4.1

removeObject(
          \eZContentObject $contentObject, bool $commit
              =
              true
          )
        
        :
          bool

static

Removes object $contentObject from the search database.

Parameters

Name	Type	Description
$contentObject	\eZContentObject	the content object to remove
$commit	bool	Whether to commit after removing the object

Returns

Type	Description
bool	True if the operation succeed.

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

Name	Type	Description
$nodeID	int
$selectedNodeID	int
$nodeIdList	array

Returns

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

Details

Since: 4.1

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

static

Notifies search engine about section changes

Parameters

Name	Type	Description
$nodeID	int
$sectionID	int

Returns

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

Details

Since: 4.1

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

static

Notifies search engine about node visibility changes

Parameters

Name	Type	Description
$nodeID	int
$action	string	"hide" or "show"

Returns

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

Details

Since: 4.1

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

static

Notifies search engine about updates to object states

Parameters

Name	Type	Description
$objectID	int
$objectStateList	array

Returns

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

Details

Since: 4.1

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

static

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

Parameters

Name	Type	Description
$objectIDs	array
$sectionID	int

Returns

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

Details

Since: 4.6

kernel/classes/ezsearch.php

\eZSearchjump to top

Methods

\eZSearch
jump to top