mrcgrtz/php-shorten

💬 Provides additional truncation functions in PHP.

Shorten

Provides additional truncation functions in PHP.

Installation

I recommend using Composer for installing and using Shorten:

composer require marcgoertz/shorten

Of course you can also just require it in your scripts directly.

Usage

<?php

use Marcgoertz\Shorten\Shorten;

$shorten = new Shorten();
print $shorten->truncateMarkup('<a href="https://example.com/">Go to example site</a>', 10);
?>

Output:

<a href="https://example.com/">Go to exam</a>…

Functions

truncateMarkup(
    string $markup,
    int $length = 400,
    string $appendix = '…',
    bool $appendixInside = false,
    bool $wordsafe = false
): string

• String $markup: Text containing markup
• Integer $length: Maximum length of truncated text (default: 400)
• String $appendix: Text added after truncated text (default: '…')
• Boolean $appendixInside: Add appendix to last content in tags, increases $length by 1 (default: false)
• Boolean $wordsafe: Wordsafe truncation (default: false)
• String $delimiter: Delimiter for wordsafe truncation (default: ' ')

License

MIT © Marc Görtz

php-shorten's Issues

Wordsafe truncation breaks if last occurrence of the delimiter is inside a tag

For example:

$string = 'Hello world <a href="#" rel="nofollow">link</a>';

echo (new Marcgoertz\Shorten\Shorten())->truncateMarkup($string, 14, '...', true, true);

Hello world <a href="#"...</a>

Handle non-XML styled self-closing tags

Shorten->truncateMarkup('<a href="https://example.com/">Go to<br />example site</a>', 10);
// ✅ '<a href="https://example.com/">Go to<br />examp</a>…'

Shorten->truncateMarkup('<a href="https://example.com/">Go to<br />example site</a>', 10);
// 🛑 '<a href="https://example.com/">Go to<br>examp</br></a>…'

Self-closing tags like <br>, <img> et al. should be handled properly.

Option to prevent html entities in result

When displaying a truncated text from this library with Twig, it displaying html entities because Twig safely encodes &.

Actually I expected UTF-8 characters are returned as is:

truncateMarkup('<p>PHP éléphant</p>', 7)

Expected:

PHP élé...

Actually:

PHP élé

I understand this makes sense, but there should be a way to disable html entities, i.e by calling html_entity_decode on truncated text before returning it (which is what we are currently doing on our side).