v1.0.40

Welcome to the Search Spell Correction Guide!

Our Search Spell Correction extension is a simple, yet powerful component that will allow you to correct all misspells, that customers can do in queries.

First, please find your extension in your account in My Downloadable Products section, then proceed with the Installation. It is best to follow our step-by-step guide to configure the best search results.

Go ahead, dive in!

Our extension works out-of-the-box, so after installation, you need just to tune-up its settings for more effective work.

This should be a good beginning!

Extension installation

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Misspell to enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install the extension.
  6. Run command php -f bin/magento cache:clean to clean the cache.

  7. Deploy static view files

    rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

  8. Run command php -f bin/magento indexer:reindex mst_misspell to reindex the extension index.

Extension installation

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_Misspell to enable the extension.
  5. Run command php -f bin/magento setup:upgrade to install the extension.
  6. Run command php -f bin/magento cache:clean to clean the cache.

  7. Deploy static view files

    rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

  8. Run command php -f bin/magento indexer:reindex mst_misspell to reindex the extension index.

Configure Search Spell Correction

All configuration options are located at Store -> Configuration -> Mirasvit Extensions -> Search Spell Correction section.

There are only two options for now. In both, our extension analyzes a customer's request and tries to find products whose names are most close to the original request.

  • Enable spell correction - enables automatic spelling correction.

    Example

    Let's assume that your store has 'Samsung' products in the catalog.

    When customer accidentally misspells Samsang phone, default Magento search will return nothing, since you have no such a product.

    But with this option enabled, the customer will be notified about potential misspelling and will see the results for the corrected search phrase Samsung phone.

  • Enable fallback search - enables searching for partial request satisfaction, when there are no results for the original request.

    Example

    Let's assume that customer puts a phrase red samsung phone to the search, but you have only samsung phone product.

    If the store has no such a product, the default Magento search also will return nothing.

    But with this option enabled, the customer will be notified about the error, and will receive results by the correct search phrase samsung phone.

Upgrade the Extension

To upgrade the extension, follow these steps:

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Run command composer require mirasvit/module-misspell:* --update-with-dependencies to update current extension with all dependencies.

    Note

    In some cases, the command above is not applicable, or it's not possible to update just the current module, or you need to upgrade all Mirasvit modules in a bundle. In this case, the command above will have no effect.

    Run instead composer update mirasvit/* command. It will update all Mirasvit modules installed in your store.

  4. Run command php -f bin/magento setup:upgrade to install the updates.
  5. Run command php -f bin/magento cache:clean to the clean cache.

  6. Deploy static view files

    rm -rf pub/static/frontend/*; rm -rf pub/static/backend/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension please follow these steps:

  1. Login to the SSH console on your server and navigate to the root directory of the Magento 2 store.
  2. Run command php -f bin/magento module:disable Mirasvit_Misspell to disable the extension.
  3. Log in to the Magento backend and refresh the store cache (if enabled).

Remove the Extension

To uninstall the extension, please follow these steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Run command composer remove mirasvit/module-misspell to remove the extension.
  3. Run command php -f bin/magento setup:upgrade.

  4. Completely clear the store cache.

    Go to System > Cache Management. Click the button Flush Magento Cache. If you want to clear the cache manually, remove the folder var/cache on the server.

Change Log

1.0.40

(2021-12-14)

Fixed

  • wrong event blocking advanced search

1.0.39

(2021-06-30)

Improvements

  • Wrong store url in autocomplete results
  • Misspell corrects second search attempt
  • Fallback run out of memory

1.0.38

(2020-10-15)

Improvements

  • Misspelling corrections

1.0.37

(2020-07-28)

Improvements

  • added comment for incompatibility with Fast Mode Autocomplete
  • Speedup spell correction

Fixed

  • misspell run on every new query
  • improve misspell results
  • fallback functionality improvements

1.0.36

(2020-03-16)

  • Code refactoring

1.0.35

(2020-01-24)

Improvements

  • Improve perfomance with InnoDB tables

1.0.34

(2019-10-08)

Fixed

  • Misspell split functionality
  • Set misspell tables to MyISAM engine

1.0.33

(2019-09-18)

Fixed

  • Spell correction don't return suggested result

1.0.32

(2019-08-13)

Fixed

  • Marketplace compatibility

1.0.31

(2019-05-27)

Fixed

  • Generators cannot return values using “return”

1.0.29

(2019-02-12)

Fixed

  • Allowed memory size error

1.0.28

(2018-11-29)

Fixed

  • Compatibility with Magento 2.3

1.0.27

(2018-10-01)

Fixed

  • ECHO

1.0.26

(2018-09-19)

Fixed

  • Issue with first suggesting in some cases

1.0.24

(2018-05-31)

Fixed

  • Issue with indexation cyrilic terms

1.0.23

(2018-04-11)

Fixed

  • Issue with error 22003

1.0.22

(2017-12-25)

Improvements

  • Integrated with Search Autocomplete
  • Added Reindex validator

1.0.21

(2017-12-13)

Improvements

  • Fallback search logic

1.0.20

(2017-11-17)

Fixed

  • Issue with _cl table

1.0.19

(2017-10-26)

Fixed

  • Possible issue with null values during indexation

1.0.18

(2017-09-28)

Fixed

  • Issue with calculation number of results for suggested search phrase

1.0.17

(2017-09-26)

Fixed

  • M2.2
  • Issue with highlighting

1.0.16

(2017-08-09)

Fixed

  • Issue with check zero result

1.0.15

(2017-07-12)

Fixed

  • Issue with Changelog changes

1.0.14

(2017-07-10)

Improvements

  • Fallback search logic

1.0.13

(2017-06-20)

Fixed

  • Compatibility issue with Amasty Shopby

1.0.12

(2017-05-10)

Improvements

  • Remove spell correction index if it disabled

1.0.11

(2017-04-11)

Improvements

  • Switched to API interfaces

1.0.10

(2017-02-20)

Improvements

  • Changed all string fuctions to mb_*

1.0.9

(2017-02-03)

Improvements

  • Added Recurring setup script for check fulltext indices

1.0.8

(2016-11-21)

Improvements

  • Compatibility with M 2.2.0

1.0.7

(2016-06-24)

Fixed

  • Compatibility with Magento 2.1

1.0.6

(2016-06-16)

Fixed

  • Fixed an issue with changing index mode for misspell index

1.0.5

(2016-04-27)

Improvements

  • Improved extension performance
  • i18n

Documentation

  • Updated installation steps

1.0.4

(2016-02-23)

Fixed

  • Fixed an issue with segmentation fault during reindex (PHP7)

1.0.3

(2016-02-07)

Documentation

  • Added user manual