eZPublish(LegacyStack)  5.1
ezpSearchEngine Interface Reference
+ Inheritance diagram for ezpSearchEngine:

Public Member Functions

 addObject ($contentObject, $commit=true)
 Adds object $contentObject to the search database. More...
 
 commit ()
 Commit the changes made to the search engine. More...
 
 needCommit ()
 Whether a commit operation is required after adding/removing objects. More...
 
 needRemoveWithUpdate ()
 Whether calling removeObject() is required when updating an object. More...
 
 removeObject ($contentObject, $commit=true)
 Removes object $contentObject from the search database. More...
 
 removeObjectById ($contentObjectId, $commit=true)
 Removes a content object by Id from the search database. More...
 
 search ($searchText, $params=array(), $searchTypes=array())
 Searches $searchText in the search database. More...
 
 supportedSearchTypes ()
 Returns an array describing the supported search types by the search engine. More...
 

Member Function Documentation

ezpSearchEngine::addObject (   $contentObject,
  $commit = true 
)

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.

Implemented in eZSearchEngine.

ezpSearchEngine::commit ( )

Commit the changes made to the search engine.

See Also
needCommit()

Implemented in eZSearchEngine.

ezpSearchEngine::needCommit ( )

Whether a commit operation is required after adding/removing objects.

See Also
commit()
Returns
bool

Implemented in eZSearchEngine.

ezpSearchEngine::needRemoveWithUpdate ( )

Whether calling removeObject() is required when updating an object.

See Also
removeObject()
Returns
bool

Implemented in eZSearchEngine.

ezpSearchEngine::removeObject (   $contentObject,
  $commit = true 
)

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.

Implemented in eZSearchEngine.

ezpSearchEngine::removeObjectById (   $contentObjectId,
  $commit = true 
)

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.

Implemented in eZSearchEngine.

ezpSearchEngine::search (   $searchText,
  $params = array(),
  $searchTypes = array() 
)

Searches $searchText in the search database.

See Also
supportedSearchTypes()
Parameters
string$searchTextSearch term
array$paramsSearch parameters
array$searchTypesSearch types

Implemented in eZSearchEngine.

ezpSearchEngine::supportedSearchTypes ( )

Returns an array describing the supported search types by the search engine.

See Also
search()
Returns
array

Implemented in eZSearchEngine.


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