Download the PHP package empiricompany/openmage-search without Composer

On this page you can find all versions of the php package empiricompany/openmage-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package openmage-search

TypeSense Search for OpenMage

Advanced search module for OpenMage using Typesense as search engine and instantsearch.js for frontend.

Overview

instantsearch

MM Search is a module that replaces the default search engine in OpenMage with Typesense, a fast and typo-tolerant search engine. This module provides:

Requirements

docker-compose.yml example for self-host a TypeSense instance with a dashboard

Installation

Via Composer

This will automatically install the latest stable version of the module.

Configuration

  1. Go to System > Configuration > MM Search
  2. Enable the module
  3. Configure the Typesense connection settings:
    • Admin API Key
    • Search-Only API Key
    • Host
    • Port
    • Protocol
    • Path
    • Collection Name
  4. Save the configuration

Indexing

This module completely replaces the default search engine in OpenMage with Typesense. When products are indexed, they are automatically added to Typesense.

To rebuild the index:

  1. Go to System > Index Management
  2. Select "Catalog Search Index"
  3. Choose "Reindex Data" from the actions dropdown
  4. Click "Submit"

Features

Instant Search

The module replaces the default search box with an instantsearch.js interface that shows results as you type.

Faceted Search

Users can filter search results by:

Typo Tolerance

Typesense's typo tolerance ensures that users find what they're looking for even if they make typos.

Customization

Templates

You can customize the search interface by modifying the following templates:

CSS

You can customize the appearance by modifying the CSS files:

JavaScript

You can customize the behavior by modifying the JavaScript file:

Troubleshooting

Common Issues

  1. Connection Failed: Make sure your Typesense server is running and accessible from your OpenMage server.
  2. No Results: Check if the products are properly indexed in Typesense. Try rebuilding the Catalog Search Index.
  3. JavaScript Errors: Check the browser console for any JavaScript errors.

License

This module is licensed under the MIT License.

All versions of openmage-search with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
magento-hackathon/magento-composer-installer Version *
typesense/typesense-php Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package empiricompany/openmage-search contains the following files

Loading the files please wait ....