opengento/module-document-search

This module aims to make documents searchable for customers in Magento 2.

2.0.0 2021-07-16 11:02 UTC

Requires

• magento/framework: ^103.0
• magento/module-theme: ^101.0
• magento/module-widget: ^101.0
• opengento/module-document: ^2.0
• opengento/module-document-widget: ^1.0||^2.0

Requires (Dev)

• magento/magento-coding-standard: ^5
• magento/marketplace-eqp: ^4.0
• roave/security-advisories: dev-master

Suggests

• opengento/module-document-product-link: This module aims to help merchants to link their documents to products in Magento 2.
• opengento/module-document-product-search: This module aims to make documents searchable with product keywords in Magento 2.
• opengento/module-document-restrict: This module aims to restrict documents by type in Magento 2.

MIT

• Opengento Team
• Thomas Klein

• php
• search
• module
• extension
• document
• magento
• magento2

README

This module aims to make documents searchable for customers in Magento 2.

• Setup
  • Composer installation
  • Setup the module
• Features
• Settings
• Documentation
• Support
• Authors
• License

Setup

Magento 2 Open Source or Commerce edition is required.

Composer installation

Run the following composer command:

composer require opengento/module-document-search

Setup the module

Run the following magento command:

bin/magento setup:upgrade

If you are in production mode, do not forget to recompile and redeploy the static resources.

Features

This module aims to make documents searchable for customers in Magento 2.
Documents can be searchable if their visibility is set to search.

Documentation

You can change the full search behavior by using the collection modifier extension point.
Add you own Magento\Framework\Data\CollectionModifierInterface implementation to the modifiers list of:

\Opengento\DocumentSearch\Model\Collection\CollectionModifier

Query parameters can be read through: \Opengento\DocumentSearch\Model\QueryData

Support

Raise a new request to the issue tracker.

Authors

• Opengento Community - Lead -
• Thomas Klein - Maintainer -
• Contributors - Contributor -

License

This project is licensed under the MIT License - see the LICENSE details.

That's all folks!