README

Lightweight PHP library designed to highlight search terms in text.

📖 Requirements

• PHP 8.1 or higher
• Composer is required for installation
• PHP Extensions: ext-intl, ext-mbstring

📦 Installation

Install the library using Composer:

$ composer require richarddobron/highlight-search-term

⚡️ Quick Start

Here’s how to use the library to highlight search terms:

use dobron\Highlight\Config\TypoTolerance;
use dobron\Highlight\Configuration;
use dobron\Highlight\HighlightFactory;

$configuration = Configuration::create()
    ->withLanguages(['en'])
    ->withMaxQueryTokens(10)
    ->withTypoTolerance(TypoTolerance::create()->withFirstCharTypoCountsDouble(false)); // can be further fine-tuned but is enabled by default

$highlightResult = (new HighlightFactory())
    ->create(__DIR__ . '/cache', $configuration)
    ->highlight('world', 'Hello world!');

echo $highlightResult->getHighlightedText(); // Hello <em>world</em>!

⚙️ Configuration Options

You can customize the library with the following methods:

📅 Change Log

Please see CHANGELOG for more information on what has changed recently.

🧪 Testing

$ composer tests

🤝 Contributing

Please see CONTRIBUTING for details.

🙋 Credits

• Richard Dobroň
• Yanick Witschi

⚖️ License

This repository is MIT licensed, as found in the LICENSE file.