loupe/context-cropper

A simple library to crop highlighted context

dev-main 2025-03-21 14:09 UTC

Requires

• php: ^8.1
• symfony/string: ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^10.5
• symfony/finder: ^6.2
• symplify/easy-coding-standard: ^12.5

MIT

• Yanick Witschi

README

A simple PHP library to crop highlighted context coming from e.g. a search engine.

Usage:

$context = 'Lorem ipsum dolor sit amet, <mark>consectetur</mark> adipiscing elit. Etiam eleifend, augue in dictum lacinia, nisi lacus mollis <mark>massa</mark>, a pulvinar felis dui nec nisl. Pellentesque justo erat, sollicitudin ac dolor finibus, dapibus lacinia diam.';

$cropper = new \Loupe\ContextCropper\ContextCropper(
    20, // Context length in characters
    '[…]',
    '<mark>',
    '</mark>'
);

echo $cropper->apply($context); // […]ipsum dolor sit amet, <mark>consectetur</mark> adipiscing elit. Etiam[…]lacinia, nisi lacus mollis <mark>massa</mark>, a pulvinar felis dui[…]