Log in

Search Module

Api\Data\SynonymGroupInterface

Interface

This interface defines the contract for managing search synonym groups in Magento 2. Developers use it to create, retrieve, and modify groups of synon...

Api\SearchInterface

Interface

This interface serves as the main entry point for search operations in Magento 2. Developers would use this interface when implementing custom search...

Api\SynonymAnalyzerInterface

Interface

This interface defines a contract for analyzing search phrases and returning synonyms for each word. Developers would implement this interface to prov...

Api\SynonymGroupRepositoryInterface

Repository

This interface defines the contract for managing synonym groups in Magento 2's search functionality. Developers use this repository to save, retrieve,...

Autocomplete

Model

This class aggregates autocomplete suggestions from multiple data providers (like products, categories, search terms) when users type in the search bo...

Autocomplete\Item

Model

This class represents a single autocomplete suggestion item in Magento's search functionality. Developers use this class to create and manage individu...

Data

Helper

This helper class provides utility methods for search functionality in Magento 2, including query validation, URL generation, and query text processin...

EngineResolver

Model

This class determines which search engine (MySQL, Elasticsearch, OpenSearch, etc.) is currently configured and active in Magento 2. Developers use it...

Model\AdapterFactory

Factory

This factory class creates search adapter instances based on the currently configured search engine (like Elasticsearch, MySQL, etc.). Developers use...

Model\AutocompleteInterface

Interface

This interface defines the contract for autocomplete functionality in Magento's search system. Developers implement this interface when creating custo...

Model\Autocomplete\DataProviderInterface

Interface

This interface defines the contract for autocomplete data providers in Magento 2's search functionality. Developers implement this interface to create...

Model\Autocomplete\ItemFactory

Factory

This factory class creates instances of autocomplete Item objects used in Magento's search functionality. Developers use this factory when they need t...

Model\Autocomplete\ItemInterface

Interface

This interface defines the contract for autocomplete suggestion items in Magento 2's search functionality. Developers implement this interface when cr...

Model\QueryFactory

Factory

This factory class creates and retrieves search Query objects in Magento 2. Developers use it to get the current search query from the request, which...

Model\QueryFactoryInterface

Interface

This interface defines a factory contract for creating search query objects in Magento 2. Developers would implement this interface to provide a stand...

Model\QueryInterface

Interface

This interface defines a contract for search query objects in Magento 2. Developers implement this interface when creating custom search query handler...

Model\ResourceModel\Query\Collection

Collection

This collection class manages search query data in Magento 2, allowing developers to retrieve and filter search terms that customers have entered in t...

Model\ResourceModel\SynonymGroup\Collection

Collection

This collection class manages groups of search synonyms in Magento 2. Developers use it to retrieve, filter, and manipulate multiple synonym group rec...

Model\SearchCollectionFactory

Factory

This factory class creates instances of SearchCollectionInterface implementations in Magento 2. Developers use this factory when they need to instanti...

Model\SearchCollectionInterface

Interface

This interface defines a contract for collections that support search functionality in Magento 2. Developers implement this interface when creating cu...

Model\SearchEngine\ValidatorInterface

Interface

This interface defines a contract for validating search engine configurations in Magento 2. Developers implement this interface to create validators t...

PopularSearchTerms

Model

This class determines whether a search term is popular enough to be cached based on store configuration. Developers use this to optimize performance b...

Query

Model

This class manages search queries in Magento 2's search functionality. Developers use it to store, retrieve, and track search terms entered by custome...

QueryResult

Model

This class represents a search query result object that encapsulates the search text and the number of results found. Developers use this as a data tr...

ResourceModel\Query

Model

This resource model manages database operations for search queries in Magento 2. Developers use it to save, load, and track search query data includin...

ResourceModel\SynonymGroup

Model

This resource model manages database operations for search synonym groups in Magento 2. Developers use it to retrieve synonym configurations scoped to...

ResourceModel\SynonymReader

Model

This resource model handles database operations for reading search synonym groups in Magento 2. Developers use it to retrieve synonym configurations f...

Search

Model

This class serves as a Web API-compatible wrapper for Magento's core search functionality. It extends the framework's base Search class and implements...

SearchEngine

Model

This class serves as the main entry point for executing search queries in Magento 2. Developers use this class when they need to perform search operat...

SearchEngine\Config

Model

This class manages search engine feature configuration in Magento 2. Developers use it to check which features are supported by a specific search engi...

SearchEngine\Config\Data

Model

This class manages the configuration data for Magento's search engine system. It extends the base Config Data class to provide cached access to search...

SearchEngine\Validator

Model

This class validates the configured search engine in Magento 2 to ensure it's supported and properly configured. It checks against a list of excluded/...

Search\PageSizeProvider

Model

This class provides the maximum page size limit for search results based on the currently configured search engine (like Elasticsearch, MySQL, etc.)....

SynonymAnalyzer

Model

This class analyzes search phrases and finds synonyms for each word in the phrase. Developers use it to enhance search functionality by expanding sear...

SynonymGroup

Model

This model manages synonym groups for search functionality in Magento 2, allowing merchants to define sets of interchangeable search terms (e.g., 'pan...

SynonymGroupRepository

Model

This repository class manages synonym groups in Magento's search functionality, allowing developers to save, retrieve, and delete groups of synonymous...

SynonymReader

Model

This class retrieves search synonyms for a given search phrase in the context of the current store view. Developers use it to load synonym groups that...

Synonym\DataProvider

Model

This class provides data for the Synonym Groups UI component grid and forms in Magento's admin panel. Developers would use this to display, filter, an...

Synonym\MergeConflictException

Model

This exception class is thrown when there's a conflict while merging synonym groups in Magento's search functionality. Developers encounter this when...