Drupal talks #6

1. Drupal 8. Search API. Facets.
Customizecombine facets.
Vitalii Zinenko,
Drupal developer at AnyforSoft
Kharkiv, Ukraine 2017
DrupalTalks#6

2. Main topics
Drupal 8 Search Api basics
Search Engines
Facets
How to facet
Combine Facets
Useful modules
DrupalTalks#6

3. 20 years ago…
DrupalTalks#6
I want to by a computer

4. 10 years ago…
DrupalTalks#6
I want to by a computer

5. 10 years ago…
DrupalTalks#6
Drupal ⅚ site
Simple search through database
Categories
Filters? - only custom code

6. Drupal 8 Search Api
DrupalTalks#6
Forget about core Search
Support for Drupal 7 and 8
You can search everything as you have Entity
Connect any backend for Search:
- Database search
- Apache SOLR, Elasticsearch

7. How Search Api works
DrupalTalks#6
Index
Central configuration
Search what/how?
Backend-independent
Server
Storage mechanism
E.g., database, Solr,
How to index, search, …
Modules
Views, Facets, …
Browser client
Site page, checkboxes,
search input.

8. Nice words to be cool
DrupalTalks#6
Index
Server
Backend
Datasource
Property Perfectionist
Field
Data type
Boost
Processor

9. Demonstrashka
DrupalTalks#6
sha budet.. one sec

10. Which backend to use
DrupalTalks#6

11. Which backend to use
DrupalTalks#6

12. FACETики
DrupalTalks#6

13. Facets
DrupalTalks#6
Dynamic filtering of results
Different widgets/types
Also relies on backend
Easy to customize

14. Facets
DrupalTalks#6
Facet API for Drupal 7
https://www.drupal.org/project/facetapi
and many related modules...
Facets for Drupal 8
https://www.drupal.org/project/facets

15. Facets d7 vs d8
DrupalTalks#6
d7
hook_facetapi_facet_info()
hook_facetapi_searcher_info()
hook_facetapi_query_types()
hook_facetapi_widgets()
hook_facetapi_filters()
hook_facetapi_sort_info()
hook_facetapi_url_processors()
d8
Facets Entity
FacetSource Plugin
Query Types Plugin
Widget Plugin
Processors Plugins

16. Plugin API
DrupalTalks#6
Extend Functionality
Plugins (Drupal 8) > Info Hooks (Drupal 7)
More info about Plugin from Zviryatko:
Drupal 8 Plugin API from O Davyskiba
https://www.youtube.com/watch?v=BzgcxPo_b00

17. DrupalTalks#6
<?php
/**
* Provides a processor that hides results start with a configurable character.
*
* @FacetsProcessor(
* id = "hide_start_with",
* label = @Translation("Hide start with some letter"),
* description = @Translation("Hide all results that start with a configurable character"),
* stages = {
* "build" = 40
* }
* )
*/
class HideStartWithProcessor {}
Annotation!!!
Customize Facets

18. DrupalTalks#6
Build Plugin
<?php
namespace Drupalhide_starts_withPluginfacetapiprocessor;
use DrupalfacetsFacetInterface;
use DrupalfacetsProcessorBuildProcessorInterface;
use DrupalfacetsProcessorProcessorPluginBase;
class HideStartWithProcessor extends ProcessorPluginBase implements BuildProcessor {
public function build(FacetInterface $facet, array $results) {
/** @var DrupalfacetsResultResultInterface $result */
foreach ($results as $id => $result) {
if (strpos(strtolower($result->getDisplayValue()), 'a') === 0) {
unset($results[$id]);
}
}
return $results;
}
}
Customize Facets

19. DrupalTalks#6
Add config
// File: config/schema/hide_starts_with.schema.yml
plugin.plugin_configuration.facets_processor.hide_starts_with:
type: mapping
label: 'Settings for the hide-starts-with processor'
mapping:
character:
type: string
label: Character
Customize Facets

20. DrupalTalks#6
::buildConfigurationForm()
<?php
class HideStartWithProcessor extends ProcessorPluginBase implements BuildProcessorInterface {
public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetInterface
$facet) {
$processors = $facet->getProcessors();
$config = isset($processors[$this->getPluginId()]) ? $processors[$this->getPluginId()] : null;
$build['character'] = [
'#title' => $this->t('Character to hide'),
'#type' => 'textfield',
'#default_value' => !is_null($config) ? $config->getConfiguration()['character'] : $this-
>defaultConfiguration()['exclude'],
'#description' => $this->t("All results that start with this character will be hidden."),
];
return $build;
}
}
Customize Facets

21. DrupalTalks#6
Update Build Plugin
<?php
class HideStartWithProcessor extends ProcessorPluginBase implements BuildProcessorInterface {
public function build(FacetInterface $facet, array $results) {
$processors = $facet->getProcessors();
$config = $processors[$this->getPluginId()];
$char = $config->getConfiguration()['character'];
/** @var DrupalfacetsResultResultInterface $result */
foreach ($results as $id => $result) {
if (strpos(strtolower($result->getDisplayValue()), $char) === 0) {
unset($results[$id]);
}
}
return $results;
}
}
Customize Facets

22. DrupalTalks#6
PluginInterface
PluginBase
Annotation
Easy?
Maybe create new widget?
Customize Facets

23. DrupalTalks#6
<?php
/**
* The slider widget.
*
* @FacetsWidget(
* id = "slider",
* label = @Translation("Slider"),
* description = @Translation("A widget that shows a slider."),
* )
*/
class SliderWidget {}
Annotation!!!
Customize Facets

24. DrupalTalks#6
<?php
namespace Drupalfacets_range_widgetPluginfacetswidget;
class SliderWidget extends WidgetPluginBase {
public function defaultConfiguration() {} // add configuration
public function build() {} // implement build
public function buildConfigurationForm(){} // build admin settings form
public function getQueryType() {}
public function isPropertyRequired() {}
}
Extend PluginBase
Customize Facets

25. eshe
Demonstrashka
DrupalTalks#6

26. Customize Facets
DrupalTalks#6
That moment when you can customize
facets

27. Combine Facets
DrupalTalks#6
Why and where to use?
facet A (7)
facet B (5)
Facet A, B (12)
facet A (7)
A.1 (5)
A.2 (3)
Facet A (15)

28. Combine Facets
DrupalTalks#6
hook__search_api_index_items_alter() {}
Custom processor. build() {}
Create custom widget() {}
Update facets template + Javascript
Solutions:

29. DrupalTalks#6
<?php
/**
* Implements hook__search_api_index_items_alter().
*/
function TEST_SITE_search_api_index_items_alter(Drupalsearch_apiIndexInterface $index,
array &$items) {
foreach ($items as $item_id => $item) {
// get original NODE
$object = $item->getOriginalObject();
// get TYPE
$type = $object->get('type')->getValue()[0]['target_id'];
// update TYPE
$type = do_something_and_change_type();
// set TYPE
$object->set('type', $type);
// set new original NODE
$item->setOriginalObject($object);
}
}
Implement hook__search_api_index_items_alter()
Combine Facets

30. one more
Demonstrashka
DrupalTalks#6

31. Useful modules
DrupalTalks#6
Search API Autocomplete
Search API Synonym
Search API Best Bets
Search API Location
Search API sorts ???

32. Search API Autocomplete
DrupalTalks#6
Suggest searches to users as they type
Easily extendable
Spell Checker
Phonetic search

33. no demonstrashka
no party
DrupalTalks#6

34. Contact information
vitalii.z@team.anyforsoft.com
/u/vitalyos
/vitalii.zinenko
anyforsoft.com
Contact me
Vitalii Zinenko
Demonstrashka master at AnyforSoft
DrupalTalks#6