Search Interface Reference
Detailed Description
Search implementations are used to search entity objects.
Definition at line 21 of file Search.php.
Inheritance diagram for Search:Public Member Functions | |
| check ($word) | |
| find ($searchTerm, PagingInfo $pagingInfo=null, $createSummary=true) | |
| isSearchable (PersistentObject $obj) | |
Member Function Documentation
◆ check()
| check | ( | $word | ) |
Check if the search word is valid.
- Parameters
-
$word
- Returns
- True, if valid, error message else
Implemented in LuceneSearch.
◆ find()
| find | ( | $searchTerm, | |
| PagingInfo | $pagingInfo = null, |
||
$createSummary = true |
|||
| ) |
Search for searchTerm.
- Parameters
-
$searchTerm $pagingInfo A PagingInfo instance (optional, default: null) $createSummary Boolean whether to create a summary or not (optional, default: true)
- Returns
- Associative array with object ids as keys and associative array with keys 'oid', 'score', 'summary' as value
Implemented in LuceneSearch.
◆ isSearchable()
| isSearchable | ( | PersistentObject | $obj | ) |
Check if the instance object is searchable (defined by the property 'isSearchable')
- Parameters
-
$obj PersistentObject instance
- Returns
- Boolean whether the object is searchable or not
Implemented in LuceneSearch.