ericpugh / drupal-usasearch Goto Github PK

• Overview
• Installation
• Requirements
• Setup Tips
• Features

DigitalGov search (formerly USASearch) is an embeddable search engine that can be used to search a site. An Affiliate profile and associated Affiliate ID are required. Read more at http://search.digitalgov.gov/developer/

DigitalGov Search offers several services:

1. A hosted search platform.
2. i14y (beta) real-time indexing API

Provides a custom search block, separate from Drupal’s system search block. When content is searched, the user will be redirected to the hosted search solution. When they click on a result, they will be sent back to your site. The search block has the optional “autocomplete” functionality, using DigitalGov’s “Type-ahead” API

This module uses the i14y API to send content directly from your Drupal installation to DigitalGov Search for real-time indexing.

For indexing you will need the i14y drawer handle. Login at https://search.usa.gov/affiliates and select Content > i14y Drawers in the left side menu. Add an i14y Drawer and enter an i14y drawer handle or select Show to display the i14y secret token of an existing drawer.

1. Place the usasearch directory in your modules directory.
2. Enable the DigitalGov Search module at admin/modules.
3. Configure it at admin/config/search/usasearch by entering DigitalGov Search’s unique affiliate name for your affiliate.

• A valid Affiliate profile from DigitalGov Search.
• Core Search module must be enabled.

After enabling the module go to /admin/structure/block to place the "USA Search Form" block in the desired region.

Developers may use an alter hook to alter the document before being sent to i14y API. For example (in {mymodule}.module file):

function mymodule_usasearch_document_alter(&$data) { // Append a string to the document title $data['title'] = $data['title'] . ', So it goes.'; return $data; }

In addition, an event 'usasearch.request' has been created and can be used by adding an event subscriber. An example module creating an event subscriber: https://github.com/ericpugh/drupal-example-event-subscriber

The module was designed to allow exporting of all the admin configuration options via Drupal 8 Configuration Management.