Download the PHP package zirak/searchable-dataobjects without Composer
On this page you can find all versions of the php package zirak/searchable-dataobjects. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zirak/searchable-dataobjects
More information about zirak/searchable-dataobjects
Files in zirak/searchable-dataobjects
Package searchable-dataobjects
Short Description This module adds DataObjects to frontend search
License GPL-2.0-only
Informations about the package searchable-dataobjects
Searchable DataObjects
Searchable DataObjects is a module that permit to include DataObjects into frontend search.
Introduction
Pages are not always the better way to implement things. For example site news can grow rapidly and the first side effect would be a big and difficult to manage SiteTree. DataObjects help maintaining things clean and straight, but unfortunately they are not included in frontend search. This module let you insert DataObject in search.
Requirements
- SilverStripe 4.1
- g4b0/htmlpurifier
For SilverStripe 3.1 usage please referr to version 3.0 and below. For SilverStripe >3.1 & <4.0 usage please referr to version 4.x.
Installation
Install the module through composer:
composer require g4b0/searchable-dataobjects
composer update
Make the DataObject (or Pages) implement Searchable interface (you need to implement Link(), getSearchFilter(), getTitleFields(), getContentFields()):
Note: getSearchFilterByCallback()
is an optional filter. If you don't plan on calculating any value to determine a returned true
or false
value it is suggested you don't add this function to your DataObject
or Page
type.
Here you are a sample page holder, needed to implement the Link() function into the DataObject:
Extend Page and the desired DataObjects through the following yaml:
Run a dev/build
and then populate the search table running PopulateSearch task:
sake dev/build "flush=all"
sake dev/tasks/PopulateSearch
Enjoy the news into the search results :)
Modifying
Set the number of search results per page
Setting the g4b0\SearchableDataObjects\CustomSearch.items_per_page
config setting you can define, how many search results per page are shown. Default is 10
By default the search result is shown at the same page, so if you're searching e.g. on the /about-us/, the results are
shown on /about-us/SearchForm/?s=foo. If you don't like that, you can define any Page or Controller class in the
g4b0\SearchableDataObjects\CustomSearch.search_controller
setting. If you set this setting to this
, the current page will be used. Defaults to SearchPage
and falls back to the current page if no SearchPage is found.
Note
Searchable DataObjects module use Mysql NATURAL LANGUAGE MODE search method, so during your tests be sure not to have all DataObjetcs with the same content, since words that are present in 50% or more of the rows are considered common and do not match.
From MySQL manual entry [http://dev.mysql.com/doc/refman/5.1/en/fulltext-search.html]:
A natural language search interprets the search string as a phrase in natural human language (a phrase in free text). There are no special operators. The stopword list applies. In addition, words that are present in 50% or more of the rows are considered common and do not match. Full-text searches are natural language searches if the IN NATURAL LANGUAGE MODE modifier is given or if no modifier is given.
TODO
- Add other search method in configuration
Suggested modules
- Linkable DataObjects: http://addons.silverstripe.org/add-ons/g4b0/linkable-dataobjects
All versions of searchable-dataobjects with dependencies
silverstripe/cms Version ^4.0
g4b0/htmlpurifier Version ~2.0