eZ Publish Community Project (Legacy Stack) 2013.4
Interface

ezpSearchEngine

interface ezpSearchEngine

This interface is used as the basis for the different search engine implementation

Methods

bool needCommit()

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

bool needRemoveWithUpdate()

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

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

Adds object $contentObject to the search database.

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

Removes object $contentObject from the search database.

bool removeObjectById(int $contentObjectId, bool $commit = true)

Removes a content object by Id from the search database.

search(string $searchText, array $params = array(), array $searchTypes = array())

Searches $searchText in the search database.

array supportedSearchTypes()

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

commit()

Commit the changes made to the search engine.

Details

at line 25
public bool needCommit()

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

Return Value

bool

See also

commit()

at line 33
public bool needRemoveWithUpdate()

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

Return Value

bool

See also

removeObject()

at line 42
public bool addObject(eZContentObject $contentObject, bool $commit = true)

Adds object $contentObject to the search database.

Parameters

eZContentObject $contentObject Object to add to search engine
bool $commit Whether to commit after adding the object

Return Value

bool True if the operation succeed.

at line 52
public bool removeObject(eZContentObject $contentObject, bool $commit = true)

Removes object $contentObject from the search database.

Parameters

eZContentObject $contentObject the content object to remove
bool $commit Whether to commit after removing the object

Return Value

bool True if the operation succeed.

at line 62
public bool removeObjectById(int $contentObjectId, bool $commit = true)

Removes a content object by Id from the search database.

Parameters

int $contentObjectId The content object to remove by id
bool $commit Whether to commit after removing the object

Return Value

bool True if the operation succeed.

Searches $searchText in the search database.

Parameters

string $searchText Search term
array $params Search parameters
array $searchTypes Search types

See also

supportedSearchTypes()

at line 80
public array supportedSearchTypes()

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

Return Value

array

See also

search()

at line 87
public commit()

Commit the changes made to the search engine.

See also

needCommit()