kernel/private/interfaces/ezpsearchengine.php
Show:
inherited
inherited
File containing the ezpSearchEngine interface
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Subpackage
- search
- Version
- 4.6.0
\ezpSearchEngine
Package: kernel\search
This interface is used as the basis for the different search engine implementation
- Children
- \eZSearchEngine
Methods
addObject(
\eZContentObject $contentObject, bool $commit
=
true
)
:
boolAdds object $contentObject to the search database.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $contentObject | \eZContentObject | Object to add to search engine |
| $commit | bool | Whether to commit after adding the object |
| Type | Description |
|---|---|
| bool | True if the operation succeed. |
commit(
)
:
voidCommit the changes made to the search engine.
Details
- See
- \needCommit()
needCommit(
)
:
boolWhether a commit operation is required after adding/removing objects.
Returns
Details
| Type | Description |
|---|---|
| bool |
- See
- \commit()
needRemoveWithUpdate(
)
:
boolWhether calling removeObject() is required when updating an object.
Returns
Details
| Type | Description |
|---|---|
| bool |
- See
- \removeObject()
removeObject(
\eZContentObject $contentObject, bool $commit
=
true
)
:
boolRemoves object $contentObject from the search database.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $contentObject | \eZContentObject | the content object to remove |
| $commit | bool | Whether to commit after removing the object |
| Type | Description |
|---|---|
| bool | True if the operation succeed. |
search(
string $searchText, array $params
=
array(), array $searchTypes
=
array()
)
:
voidSearches $searchText in the search database.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $searchText | string | Search term |
| $params | array | Search parameters |
| $searchTypes | array | Search types |
- See
- \supportedSearchTypes()
supportedSearchTypes(
)
:
arrayReturns an array describing the supported search types by the search engine.
Returns
Details
| Type | Description |
|---|---|
| array |
- See
- \search()