mirror of
https://github.com/silverstripe/silverstripe-fulltextsearch
synced 2024-10-22 12:05:29 +00:00
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
# FullTextSearch module
|
|
|
|
[](https://travis-ci.org/silverstripe/silverstripe-fulltextsearch)
|
|
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-fulltextsearch/?branch=master)
|
|
[](https://codecov.io/gh/silverstripe/silverstripe-fulltextsearch)
|
|
[](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
|
|
|
Adds support for fulltext search engines like Sphinx and Solr to SilverStripe CMS.
|
|
Compatible with PHP 7.2
|
|
|
|
## Maintainer Contact
|
|
|
|
* Hamish Friedlander <hamish (at) silverstripe (dot) com>
|
|
|
|
## Requirements
|
|
|
|
* SilverStripe 4.0+
|
|
|
|
**Note:** For SilverStripe 3.x, please use the [2.x release line](https://github.com/silverstripe/silverstripe-fulltextsearch/tree/2).
|
|
|
|
## Documentation
|
|
|
|
For pure Solr docs, check out [the Solr 4.10.4 guide](https://archive.apache.org/dist/lucene/solr/ref-guide/apache-solr-ref-guide-4.10.pdf).
|
|
|
|
See [the docs](/docs/en/00_index.md) for configuration and setup, or for the quick version see [the quick start guide](/docs/en/01_getting_started.md#quick-start).
|
|
|
|
For details of updates, bugfixes, and features, please see the [changelog](CHANGELOG.md).
|
|
|
|
## TODO
|
|
|
|
* Get rid of includeSubclasses - isn't actually used in practice, makes the codebase uglier, and ClassHierarchy can be
|
|
used at query time for most of the same use cases
|
|
|
|
* Fix field referencing in queries. Should be able to do `$query->search('Text', 'Content')`, not
|
|
`$query->search('Text', SiteTree::class . '_Content')` like you have to do now
|
|
|
|
- Make sure that when field exists in multiple classes, searching against bare fields searches all of them
|
|
|
|
- Allow searching against specific instances too
|
|
|
|
* Make fields restrictable by class in an index - 'SiteTree#Content' to limit fields to a particular class,
|
|
maybe 'Content->Summary' to allow calling a specific method on the field object to get the text
|
|
|
|
* Allow following user relationships (Children.Foo for example)
|
|
|
|
* Be clearer about what happens with relationships to stateful objects (e.g. Parent.Foo where Parent is versioned)
|
|
|
|
* Improvements to SearchUpdater
|
|
|
|
- Make it work properly when in-between objects (the A in A.B.Foo) update
|
|
|
|
- Allow user logic to cause triggering reindex of documents when field is user generated
|
|
|
|
* Add generic APIs for spell correction, file text extraction and snippet generation
|