https://github.com/opengento/magento2-document-search

This module aims to make documents searchable for customers in Magento 2.
https://github.com/opengento/magento2-document-search

document-management document-search magento magento-2 magento-extension magento-module magento-search magento2 magento2-extension magento2-extension-free magento2-module php search

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/opengento/magento2-document-search
• Owner: opengento
• License: mit
• Created: 2020-12-06T17:25:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T17:19:19.000Z (10 months ago)
• Last Synced: 2025-04-23T21:05:58.649Z (about 1 month ago)
• Topics: document-management, document-search, magento, magento-2, magento-extension, magento-module, magento-search, magento2, magento2-extension, magento2-extension-free, magento2-module, php, search
• Language: PHP
• Homepage: https://opengento.fr
• Size: 30.3 KB
• Stars: 3
• Watchers: 8
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Document Module for Magento 2

[![Latest Stable Version](https://img.shields.io/packagist/v/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search)

[![License: MIT](https://img.shields.io/github/license/opengento/magento2-document-search.svg?style=flat-square)](./LICENSE) 

[![Packagist](https://img.shields.io/packagist/dt/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats)

[![Packagist](https://img.shields.io/packagist/dm/opengento/module-document-search.svg?style=flat-square)](https://packagist.org/packages/opengento/module-document-search/stats)

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

 - [Setup](#setup)

   - [Composer installation](#composer-installation)

   - [Setup the module](#setup-the-module)

 - [Features](#features)

 - [Settings](#settings)

 - [Documentation](#documentation)

 - [Support](#support)

 - [Authors](#authors)

 - [License](#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](https://github.com/opengento/magento2-document-search/issues) to the issue tracker.

## Authors

- **Opengento Community** - *Lead* - [![Twitter Follow](https://img.shields.io/twitter/follow/opengento.svg?style=social)](https://twitter.com/opengento)

- **Thomas Klein** - *Maintainer* - [![GitHub followers](https://img.shields.io/github/followers/thomas-kl1.svg?style=social)](https://github.com/thomas-kl1)

- **Contributors** - *Contributor* - [![GitHub contributors](https://img.shields.io/github/contributors/opengento/magento2-document-search.svg?style=flat-square)](https://github.com/opengento/magento2-document-search/graphs/contributors)

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) details.

***That's all folks!***