Download the PHP package nglasl/silverstripe-extensible-search without Composer
On this page you can find all versions of the php package nglasl/silverstripe-extensible-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nglasl/silverstripe-extensible-search
More information about nglasl/silverstripe-extensible-search
Files in nglasl/silverstripe-extensible-search
Package silverstripe-extensible-search
Short Description This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.
License BSD-3-Clause
Homepage https://github.com/nglasl/silverstripe-extensible-search
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silverstripe-extensible-search
extensible search
The current release is 4.1.4
This module allows user customisation and developer extension of a search page instance, including analytics and suggestions.
Requirement
- SilverStripe 3.1 → 4.0
Getting Started
- Place the module under your root project directory.
- Configure the search engine and search form YAML.
/dev/build- Configure the extensible search page.
Overview
Extensible Search Page
This is automatically created, and allows configuration for search based on a search engine (more below).
Search Engine
The extensible search page is designed to use full-text search out of the box, while providing support for custom search engine implementations (elastic search for example).
Full-Text
When considering the search engine to use, full-text has some important limitations. This configuration can also be applied to File, however, unfortunately it does not support further customisation.
Custom Search Engine
The following is an example configuration, where ElasticSearch extends the abstract CustomSearchEngine class:
Search Form
Using this, to display the search form that users interact with (from your template):
Search Analytics
These are important to help determine either popular content on your site, or whether content is difficult for users to locate. They're automatically enabled out of the box, however, can be disabled using the following:
When triggering a search, appending ?analytics=false to the URL will bypass the search analytics. This is fantastic for debugging.
Archiving
Depending on your search traffic, /dev/tasks/ExtensibleSearchArchiveTask may be used to archive past search analytics, for each search page. It would be recommended to trigger this on a schedule where possible.
Search Suggestions
These are most effective alongside the search analytics (in which case they're automatically populated), and can be used to display either popular searches on your site, or search form autocomplete options. They're automatically enabled out of the box, however, can be disabled using the following:
To enable autocomplete using the approved search suggestions..
Smart Templating
Custom search engine specific templates may be defined for your search results. These are just two examples:
ElasticSearch_results.ss or Page_results.ss
SS4 Changes
- The custom search engine implementation has changed, and no longer uses extensions (see above).
Maintainer Contact
Nathan Glasl, [email protected]