PHPackages                             labor-digital/typo3-search-and-index - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. labor-digital/typo3-search-and-index

ActiveTypo3-cms-extension[Search & Filtering](/categories/search)

labor-digital/typo3-search-and-index
====================================

A fast, faceted search engine for TYPO3 records which also creates a complete xml sitemap if you desire

10.3.1(3y ago)01.1kApache-2.0PHP

Since Jul 20Pushed 3y ago1 watchersCompare

[ Source](https://github.com/labor-digital/typo3-search-and-index)[ Packagist](https://packagist.org/packages/labor-digital/typo3-search-and-index)[ RSS](/packages/labor-digital-typo3-search-and-index/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (2)Versions (19)Used By (0)

TYPO3 - Search and Index
========================

[](#typo3---search-and-index)

This package provides a powerful, facetable, language- and domainaware PHP based Search implementation. The search is performed using an intelligent SQL query to perform complex, fuzzy searches in milli-seconds. To provide high performance, the search is executed on an index of all your contents in your TYPO3 installation. The search can handle custom record types with ease using a class based, extendable indexing algorithm. The indexing of pages is already implemented with its own indexer task.

Based on the index you can also generate a complete xml sitemap.

Requirements
------------

[](#requirements)

- TYPO3 v10
- [TYPO3 - Better API](https://github.com/labor-digital/typo3-better-api)
- Installation using Composer

Installation
------------

[](#installation)

Install this package using composer:

```
composer require labor-digital/typo3-search-and-index

```

After that, you can activate the extension in the Extensions-Manager of your TYPO3 installation

Documentation
-------------

[](#documentation)

You can find a documented implementation in the [T3SAI branch](https://github.com/labor-digital/typo3-better-api-example/tree/feat-search-and-index) of the T3BA example repository.

- [Take a look on how indexers are written](https://github.com/labor-digital/typo3-better-api-example/tree/feat-search-and-index/Classes/Search)
- [See how you create search domains](https://github.com/labor-digital/typo3-better-api-example/blob/feat-search-and-index/Configuration/ExtConfig/Site/Main/SearchAndIndex.php)

### Running the indexer

[](#running-the-indexer)

To run the indexer, either use the "t3sai:indexer" cli command, or create a new Scheduler task using the "Search and Index - Indexer" class. You can also run the indexer by using the "LaborDigital\\T3sai\\Core\\Indexer\\Indexer" class in your code.

### Provided routes

[](#provided-routes)

- GET /t3sai/sitemap.xml Provides the sitemap (based on the requesting hostname), generated based on the search index.
- POST /t3sai/autocomplete Provides an endpoint to generate Ajax autocomplete features. Simply POST your request with your input string as "search" (form-data) and receive the list of autocomplete results as JSON. You might also send a domainIdentifier as "domain" to narrow down the autocomplete results.

### T3FA integration

[](#t3fa-integration)

If you are using the [TYPO3 Frontend API extension](https://github.com/labor-digital/typo3-frontend-api)the [Provided routes](#provided-routes) will automatically be disabled!

Instead, you can utilize the api capabilities provided by T3FA when running searches, deploying the sitemap.xml or resolving autocomplete results.

#### Search Bundle

[](#search-bundle)

The search bundle includes two resources which can be used to access the search index, completely through the api.

Register the bundle like this:

```